BridgeSuccess

Represents a successful bridge response. The ok: true discriminator lets TypeScript narrow the response and safely expose the data payload.

Importing

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

Usage

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

const response: BridgeSuccess<{ id: string }> = {
    ok: true,
    message: null,
    data: { id: '1' }
}

Parameters

Name	Description
T	Success payload type stored in data.

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 BridgeSuccess<T> = {
    ok: true;
    message: string | null;
    data: T;
};