API ​

API reference for @webext-core/messaging.

defineExtensionMessaging ​

function defineExtensionMessaging<
  TProtocolMap = Record<string, ProtocolWithReturn<any, any>>
>(config?: ExtensionMessagingConfig): Messenger<TProtocolMap> {
  // ...
}

Creates a new Messenger used to send and recieve messages in your extension.

Parameters ​

• config?: ExtensionMessagingConfig
  Configure the behavior of the messenger.

ExtensionMessagingConfig ​

interface ExtensionMessagingConfig {
  logger?: Logger | null;
}

Configure how the messenger behaves.

Properties ​

• logger?: Logger | null (default: console)
  The logger to use when logging messages. Set to null to disable logging.

GetDataType ​

type GetDataType<T> = T extends (...args: infer Args) => any
  ? Args["length"] extends 0 | 1
    ? Args[0]
    : never
  : T extends ProtocolWithReturn<any, any>
  ? T["BtVgCTPYZu"]
  : T;

Given a function declaration, ProtocolWithReturn, or a value, return the message's data type.

GetReturnType ​

type GetReturnType<T> = T extends (...args: any[]) => infer R
  ? R
  : T extends ProtocolWithReturn<any, any>
  ? T["RrhVseLgZW"]
  : void;

Given a function declaration, ProtocolWithReturn, or a value, return the message's return type.

Logger ​

interface Logger {
  debug(...args: any[]): void;
  log(...args: any[]): void;
  warn(...args: any[]): void;
  error(...args: any[]): void;
}

Interface used to log text to the console when sending and recieving messages.

MaybePromise ​

type MaybePromise<T> = Promise<T> | T;

Either a Promise of a type, or that type directly. Used to indicate that a method can by sync or async.

Messenger ​

interface Messenger<TProtocolMap> {
  sendMessage<TType extends keyof TProtocolMap>(
    type: TType,
    data: GetDataType<TProtocolMap[TType]>,
    tabId?: number
  ): Promise<GetReturnType<TProtocolMap[TType]>>;
  onMessage<TType extends keyof TProtocolMap>(
    type: TType,
    onReceived: OnMessageReceived<TProtocolMap, TType>
  ): RemoveListenerCallback;
  removeAllMessageListeners(): void;
}

Use the functions defined in the messenger to send and recieve messages throughout your entire extension.

Unlike the regular chrome.runtime messaging APIs, there are no limitations to when you call onMessage or sendMessage.

ProtocolWithReturn ​

interface ProtocolWithReturn<TData, TReturn> {
  BtVgCTPYZu: TData;
  RrhVseLgZW: TReturn;
}

Used to add a return type to a message in the protocol map.

Internally, this is just an object with random keys for the data and return types.

Properties ​

• BtVgCTPYZu: TData
  Stores the data type. Randomly named so that it isn't accidentally implemented.

• RrhVseLgZW: TReturn
  Stores the return type. Randomly named so that it isn't accidentally implemented.

Examples ​

interface ProtocolMap {
  // data is a string, returns undefined
  type1: string;
  // data is a string, returns a number
  type2: ProtocolWithReturn<string, number>;
}

RemoveListenerCallback ​

type RemoveListenerCallback = () => void;

Call to ensure an active listener has been removed.

If the listener has already been removed with Messenger.removeAllListeners, this is a noop.

API reference generated by plugins/typescript-docs.ts