z-ipc
Version:
Z-IPC is an easy-to-use, extensible and fully type-safe IPC solution for JavaScript environments.
24 lines (22 loc) • 659 B
TypeScript
/**
* An adapter is an IPC primitive that allows to send and receive messages.
*/
type Adapter<TMessage = unknown> = {
/**
* Publish a message.
*/
publish: (message: TMessage) => void;
/**
* Subscribe to messages.
*/
subscribe: (callback: (message: TMessage) => void) => void;
/**
* Unsubscribe from messages.
*/
unsubscribe: (callback: (message: TMessage) => void) => void;
};
/**
* A helper function that allows to define adapter in a more convenient way.
*/
declare function defineAdapter<TMessage>(adapter: Adapter<TMessage>): Adapter<TMessage>;
export { type Adapter as A, defineAdapter as d };