getErrorDetailsAs

Casts bridge error details to the expected details type. Use it after checking the error code or error type when native code returns structured failure information.

Importing

import { getErrorDetailsAs } from '@almighty-shogun/webkit-native-bridge';

Usage

import {
    createNativeBridge,
    getErrorDetailsAs
} from '@almighty-shogun/webkit-native-bridge';

type ValidationDetails = { field: string };

type Requests = {
    saveUser: {
        body: {
            name: string
        };
        response: void
    }
}

const bridge = createNativeBridge<Requests>();
const response = await bridge.request('saveUser', { name: '' });

if (!response.ok) {
    const details = getErrorDetailsAs<ValidationDetails>(response.error);

    console.warn(details?.field);
}

Parameters

error: BridgeError
Error containing details.

Returns

The error details cast to Nullable<TExpectedDetails>.

Uses

• Nullable

Type signature

declare function getErrorDetailsAs<TExpectedDetails>(
    error: BridgeError
): Nullable<TExpectedDetails>;