123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114 |
- type ArgumentsType<T> = T extends (...args: infer A) => any ? A : never;
- type ReturnType<T> = T extends (...args: any) => infer R ? R : never;
- type PromisifyFn<T> = ReturnType<T> extends Promise<any> ? T : (...args: ArgumentsType<T>) => Promise<Awaited<ReturnType<T>>>;
- type BirpcResolver = (name: string, resolved: (...args: unknown[]) => unknown) => ((...args: unknown[]) => unknown) | undefined;
- interface ChannelOptions {
- /**
- * Function to post raw message
- */
- post: (data: any, ...extras: any[]) => any | Promise<any>;
- /**
- * Listener to receive raw message
- */
- on: (fn: (data: any, ...extras: any[]) => void) => any | Promise<any>;
- /**
- * Clear the listener when `$close` is called
- */
- off?: (fn: (data: any, ...extras: any[]) => void) => any | Promise<any>;
- /**
- * Custom function to serialize data
- *
- * by default it passes the data as-is
- */
- serialize?: (data: any) => any;
- /**
- * Custom function to deserialize data
- *
- * by default it passes the data as-is
- */
- deserialize?: (data: any) => any;
- /**
- * Call the methods with the RPC context or the original functions object
- */
- bind?: 'rpc' | 'functions';
- }
- interface EventOptions<Remote> {
- /**
- * Names of remote functions that do not need response.
- */
- eventNames?: (keyof Remote)[];
- /**
- * Maximum timeout for waiting for response, in milliseconds.
- *
- * @default 60_000
- */
- timeout?: number;
- /**
- * Custom resolver to resolve function to be called
- *
- * For advanced use cases only
- */
- resolver?: BirpcResolver;
- /**
- * Custom error handler
- *
- * @deprecated use `onFunctionError` and `onGeneralError` instead
- */
- onError?: (error: Error, functionName: string, args: any[]) => boolean | void;
- /**
- * Custom error handler for errors occurred in local functions being called
- *
- * @returns `true` to prevent the error from being thrown
- */
- onFunctionError?: (error: Error, functionName: string, args: any[]) => boolean | void;
- /**
- * Custom error handler for errors occurred during serialization or messsaging
- *
- * @returns `true` to prevent the error from being thrown
- */
- onGeneralError?: (error: Error, functionName?: string, args?: any[]) => boolean | void;
- /**
- * Custom error handler for timeouts
- *
- * @returns `true` to prevent the error from being thrown
- */
- onTimeoutError?: (functionName: string, args: any[]) => boolean | void;
- }
- type BirpcOptions<Remote> = EventOptions<Remote> & ChannelOptions;
- type BirpcFn<T> = PromisifyFn<T> & {
- /**
- * Send event without asking for response
- */
- asEvent: (...args: ArgumentsType<T>) => void;
- };
- interface BirpcGroupFn<T> {
- /**
- * Call the remote function and wait for the result.
- */
- (...args: ArgumentsType<T>): Promise<Awaited<ReturnType<T>>[]>;
- /**
- * Send event without asking for response
- */
- asEvent: (...args: ArgumentsType<T>) => void;
- }
- type BirpcReturn<RemoteFunctions, LocalFunctions = Record<string, never>> = {
- [K in keyof RemoteFunctions]: BirpcFn<RemoteFunctions[K]>;
- } & {
- $functions: LocalFunctions;
- $close: (error?: Error) => void;
- };
- type BirpcGroupReturn<RemoteFunctions> = {
- [K in keyof RemoteFunctions]: BirpcGroupFn<RemoteFunctions[K]>;
- };
- interface BirpcGroup<RemoteFunctions, LocalFunctions = Record<string, never>> {
- readonly clients: BirpcReturn<RemoteFunctions, LocalFunctions>[];
- readonly functions: LocalFunctions;
- readonly broadcast: BirpcGroupReturn<RemoteFunctions>;
- updateChannels: (fn?: ((channels: ChannelOptions[]) => void)) => BirpcReturn<RemoteFunctions, LocalFunctions>[];
- }
- declare const DEFAULT_TIMEOUT = 60000;
- declare function createBirpc<RemoteFunctions = Record<string, never>, LocalFunctions extends object = Record<string, never>>(functions: LocalFunctions, options: BirpcOptions<RemoteFunctions>): BirpcReturn<RemoteFunctions, LocalFunctions>;
- declare function cachedMap<T, R>(items: T[], fn: ((i: T) => R)): R[];
- declare function createBirpcGroup<RemoteFunctions = Record<string, never>, LocalFunctions extends object = Record<string, never>>(functions: LocalFunctions, channels: ChannelOptions[] | (() => ChannelOptions[]), options?: EventOptions<RemoteFunctions>): BirpcGroup<RemoteFunctions, LocalFunctions>;
- export { type ArgumentsType, type BirpcFn, type BirpcGroup, type BirpcGroupFn, type BirpcGroupReturn, type BirpcOptions, type BirpcResolver, type BirpcReturn, type ChannelOptions, DEFAULT_TIMEOUT, type EventOptions, type PromisifyFn, type ReturnType, cachedMap, createBirpc, createBirpcGroup };
|