NativeMethodsWithBody

Extracts request method keys whose body type is neither void nor undefined. These methods require a body argument when calling bridge.request().

Importing

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

Usage

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

type Requests = {
    getUser: { body: { id: string }; response: { name: string } }
    ping: { body: void; response: 'pong' }
}

type MethodsRequiringBody = NativeMethodsWithBody<Requests>;

// 'getUser'

Parameters

Name	Description
TRequests	Request map to inspect for methods requiring a body.

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 NativeMethodsWithBody<TRequests extends NativeBridgeRequestMap> =
    Exclude<keyof TRequests, NativeMethodsWithoutBody<TRequests>>;