NativeRequestBody

Extracts the request body type for one method in a request map. It is used internally by the bridge request overloads and can also be reused in application code.

Importing

import type { NativeRequestBody } from '@almighty-shogun/webkit-native-bridge'

Usage

import type { NativeRequestBody } from '@almighty-shogun/webkit-native-bridge'

type Requests = {
    getUser: { body: { id: string }; response: { name: string } }
}

type GetUserBody = NativeRequestBody<Requests, 'getUser'>;

// { id: string }

Parameters

Name	Description
TRequests	Request map containing the method definition.
TMethod	Method key whose request body should be resolved.

Returns

A TypeScript type for native bridge APIs. It is erased at runtime and is used only by TypeScript to describe the shape of values passed to or returned from the package APIs.

Type signature

type NativeRequestBody<
    TRequests extends NativeBridgeRequestMap,
    TMethod extends keyof TRequests
> =
    TRequests[TMethod]['body'];