NativeBridge

Runtime bridge object returned by createNativeBridge. It exposes low-level posting, typed requests, command calls, availability checks, manual response handling, and disposal.

Importing

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

Usage

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

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

type AppBridge = NativeBridge<Requests, 'close'>;

Parameters

Name	Description
TRequests	Request map used to type request method names, request bodies, responses, and native errors.
TCommands	String union of fire-and-forget command names. Defaults to never.

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 NativeBridge<
    TRequests extends NativeBridgeRequestMap,
    TCommands extends string = never
> = {
    call(method: TCommands): void;
    dispose(): void;
    handleResponse(detail: NativeResponseEventDetail): void;
    isAvailable(): boolean;
    postMessage(message: string): void;
    request: {
        <TMethod extends NativeMethodsWithoutBody<TRequests>>(
            method: TMethod,
            body?: undefined,
            options?: NativeRequestOptions
        ): Promise<
            BridgeResponse<NativeResponseBody<TRequests, TMethod>>
        >;

        <TMethod extends NativeMethodsWithBody<TRequests>>(
            method: TMethod,
            body: NativeRequestBody<TRequests, TMethod>,
            options?: NativeRequestOptions
        ): Promise<
            BridgeResponse<NativeResponseBody<TRequests, TMethod>>
        >;
    };
};