NativeBridgeWindow

Window shape expected by the WebKit bridge. It extends Window with the optional webkit.messageHandlers object used by WebKit hosts.

Importing

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

Usage

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

function hasBridge(window: NativeBridgeWindow) {
    return window.webkit?.messageHandlers?.nativeBridge !== undefined;
}

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 NativeBridgeWindow = Window & {
    webkit?: {
        messageHandlers?: Record<
            string,
            NativeBridgeMessageHandler | undefined
        >;
    };
};