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 Thenable<T> = T | PromiseLike<T>;
|
type BirpcResolver<This> = (this: This, name: string, resolved: (...args: unknown[]) => unknown) => Thenable<((...args: any[]) => any) | 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';
|
/**
|
* Custom meta data to attached to the RPC instance's `$meta` property
|
*/
|
meta?: any;
|
}
|
interface EventOptions<RemoteFunctions, LocalFunctions extends object = Record<string, never>> {
|
/**
|
* Names of remote functions that do not need response.
|
*/
|
eventNames?: (keyof RemoteFunctions)[];
|
/**
|
* 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<BirpcReturn<RemoteFunctions, LocalFunctions>>;
|
/**
|
* Hook triggered before an event is sent to the remote
|
*
|
* @param req - Request parameters
|
* @param next - Function to continue the request
|
* @param resolve - Function to resolve the response directly
|
*/
|
onRequest?: (this: BirpcReturn<RemoteFunctions, LocalFunctions>, req: Request, next: (req?: Request) => Promise<any>, resolve: (res: any) => void) => void | Promise<void>;
|
/**
|
* Custom error handler
|
*
|
* @deprecated use `onFunctionError` and `onGeneralError` instead
|
*/
|
onError?: (this: BirpcReturn<RemoteFunctions, LocalFunctions>, 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?: (this: BirpcReturn<RemoteFunctions, LocalFunctions>, 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?: (this: BirpcReturn<RemoteFunctions, LocalFunctions>, error: Error, functionName?: string, args?: any[]) => boolean | void;
|
/**
|
* Custom error handler for timeouts
|
*
|
* @returns `true` to prevent the error from being thrown
|
*/
|
onTimeoutError?: (this: BirpcReturn<RemoteFunctions, LocalFunctions>, functionName: string, args: any[]) => boolean | void;
|
}
|
type BirpcOptions<RemoteFunctions, LocalFunctions extends object = Record<string, never>> = EventOptions<RemoteFunctions, LocalFunctions> & ChannelOptions;
|
type BirpcFn<T> = PromisifyFn<T> & {
|
/**
|
* Send event without asking for response
|
*/
|
asEvent: (...args: ArgumentsType<T>) => Promise<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>) => Promise<void>;
|
}
|
interface BirpcReturnBuiltin<RemoteFunctions, LocalFunctions = Record<string, never>> {
|
/**
|
* Raw functions object
|
*/
|
$functions: LocalFunctions;
|
/**
|
* Whether the RPC is closed
|
*/
|
readonly $closed: boolean;
|
/**
|
* Custom meta data attached to the RPC instance
|
*/
|
readonly $meta: any;
|
/**
|
* Close the RPC connection
|
*/
|
$close: (error?: Error) => void;
|
/**
|
* Reject pending calls
|
*/
|
$rejectPendingCalls: (handler?: PendingCallHandler) => Promise<void>[];
|
/**
|
* Call the remote function and wait for the result.
|
* An alternative to directly calling the function
|
*/
|
$call: <K extends keyof RemoteFunctions>(method: K, ...args: ArgumentsType<RemoteFunctions[K]>) => Promise<Awaited<ReturnType<RemoteFunctions[K]>>>;
|
/**
|
* Same as `$call`, but returns `undefined` if the function is not defined on the remote side.
|
*/
|
$callOptional: <K extends keyof RemoteFunctions>(method: K, ...args: ArgumentsType<RemoteFunctions[K]>) => Promise<Awaited<ReturnType<RemoteFunctions[K]> | undefined>>;
|
/**
|
* Send event without asking for response
|
*/
|
$callEvent: <K extends keyof RemoteFunctions>(method: K, ...args: ArgumentsType<RemoteFunctions[K]>) => Promise<void>;
|
/**
|
* Call the remote function with the raw options.
|
*/
|
$callRaw: (options: {
|
method: string;
|
args: unknown[];
|
event?: boolean;
|
optional?: boolean;
|
}) => Promise<Awaited<ReturnType<any>>[]>;
|
}
|
type BirpcReturn<RemoteFunctions, LocalFunctions = Record<string, never>> = {
|
[K in keyof RemoteFunctions]: BirpcFn<RemoteFunctions[K]>;
|
} & BirpcReturnBuiltin<RemoteFunctions, LocalFunctions>;
|
type PendingCallHandler = (options: Pick<PromiseEntry, 'method' | 'reject'>) => void | Promise<void>;
|
interface BirpcGroupReturnBuiltin<RemoteFunctions> {
|
/**
|
* Call the remote function and wait for the result.
|
* An alternative to directly calling the function
|
*/
|
$call: <K extends keyof RemoteFunctions>(method: K, ...args: ArgumentsType<RemoteFunctions[K]>) => Promise<Awaited<ReturnType<RemoteFunctions[K]>>>;
|
/**
|
* Same as `$call`, but returns `undefined` if the function is not defined on the remote side.
|
*/
|
$callOptional: <K extends keyof RemoteFunctions>(method: K, ...args: ArgumentsType<RemoteFunctions[K]>) => Promise<Awaited<ReturnType<RemoteFunctions[K]> | undefined>>;
|
/**
|
* Send event without asking for response
|
*/
|
$callEvent: <K extends keyof RemoteFunctions>(method: K, ...args: ArgumentsType<RemoteFunctions[K]>) => Promise<void>;
|
}
|
type BirpcGroupReturn<RemoteFunctions> = {
|
[K in keyof RemoteFunctions]: BirpcGroupFn<RemoteFunctions[K]>;
|
} & BirpcGroupReturnBuiltin<RemoteFunctions>;
|
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>[];
|
}
|
interface PromiseEntry {
|
resolve: (arg: any) => void;
|
reject: (error: any) => void;
|
method: string;
|
timeoutId?: ReturnType<typeof setTimeout>;
|
}
|
declare const TYPE_REQUEST: "q";
|
interface Request {
|
/**
|
* Type
|
*/
|
t: typeof TYPE_REQUEST;
|
/**
|
* ID
|
*/
|
i?: string;
|
/**
|
* Method
|
*/
|
m: string;
|
/**
|
* Arguments
|
*/
|
a: any[];
|
/**
|
* Optional
|
*/
|
o?: boolean;
|
}
|
declare const DEFAULT_TIMEOUT = 60000;
|
declare const setTimeout: typeof globalThis.setTimeout;
|
declare function createBirpc<RemoteFunctions = Record<string, never>, LocalFunctions extends object = Record<string, never>>($functions: LocalFunctions, options: BirpcOptions<RemoteFunctions, LocalFunctions>): 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, LocalFunctions>): BirpcGroup<RemoteFunctions, LocalFunctions>;
|
|
export { DEFAULT_TIMEOUT, cachedMap, createBirpc, createBirpcGroup };
|
export type { ArgumentsType, BirpcFn, BirpcGroup, BirpcGroupFn, BirpcGroupReturn, BirpcGroupReturnBuiltin, BirpcOptions, BirpcResolver, BirpcReturn, BirpcReturnBuiltin, ChannelOptions, EventOptions, PromisifyFn, ReturnType, Thenable };
|
