BridgeFailure

Represents a failed bridge response. The ok: false discriminator lets TypeScript narrow the response and expose the structured error object.

Importing

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

Usage

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

const failure: BridgeFailure<'TIMEOUT'> = {
    ok: false,
    message: 'Timed out',
    error: { type: 'transport', code: 'TIMEOUT', message: 'Timed out', details: null }
}

Parameters

Name	Description
TCode	Error code union for the failure. Defaults to string.
TDetails	Optional structured details returned with the error. Defaults to unknown.

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 BridgeFailure<
    TCode extends string = string,
    TDetails = unknown
> = {
    ok: false;
    message: string | null;
    error: BridgeError<TCode, TDetails>;
};