Class RPCChannel<LocalAPI, RemoteAPI, Io>

A bidirectional Stdio IPC channel in RPC style. This allows 2 JS/TS processes to call each other's API like using libraries in RPC style, without needing to deal with argv, stdin, stdout directly.

Type Parameters

LocalAPI extends Record<string, any>
RemoteAPI extends Record<string, any>
Io extends IoInterface = IoInterface

Index

Constructors

constructor

Methods

callConstructor callMethod expose freeCallbacks getAPI getIO getProperty setProperty

Constructors

constructor

new RPCChannel<
    LocalAPI extends Record<string, any>,
    RemoteAPI extends Record<string, any>,
    Io extends IoInterface = IoInterface,
>(
    io: Io,
    options?: { expose?: LocalAPI; serialization?: SerializationOptions },
): RPCChannel<LocalAPI, RemoteAPI, Io>
Type Parameters
- LocalAPI extends Record<string, any>
- RemoteAPI extends Record<string, any>
- Io extends IoInterface = IoInterface
Parameters
- io: Io
- Optionaloptions: { expose?: LocalAPI; serialization?: SerializationOptions }
Returns RPCChannel<LocalAPI, RemoteAPI, Io>
- Defined in src/channel.ts:41

Methods

callConstructor

callConstructor<T extends string | number | symbol>(
constructor: T,
args: any[],
): Promise<any>
Calls a constructor on the remote API
Type Parameters
- T extends string | number | symbol
Parameters
- constructor: T
  The name of the constructor to call
- args: any[]
  Arguments to pass to the remote constructor
Returns Promise<any>
Promise that resolves with the constructed instance
- Defined in src/channel.ts:226

callMethod

callMethod<T extends string | number | symbol>(
method: T,
args: any[],
): Promise<void>
Calls a method on the remote API
Type Parameters
- T extends string | number | symbol
Parameters
- method: T
  The name of the method to call
- args: any[]
  Arguments to pass to the remote method
Returns Promise<void>
Promise that resolves with the result of the remote call
- Defined in src/channel.ts:140

expose

expose(api: LocalAPI): void
Exposes a local API implementation that can be called remotely
Parameters
- api: LocalAPI
  The local API implementation to expose
Returns void
- Defined in src/channel.ts:58

freeCallbacks

freeCallbacks(): void
Frees up memory by clearing stored callbacks and callback cache Useful when dealing with many anonymous callback functions to prevent memory leaks

Returns void
- Defined in src/channel.ts:572

getAPI

getAPI(): RemoteAPI
Returns a proxy object that represents the remote API Methods called on this proxy will be executed on the remote endpoint

Returns RemoteAPI
Proxy object representing the remote API
- Defined in src/channel.ts:564

getIO

getIO(): Io
Returns the IO interface used by this channel

Returns Io
The IO interface instance
- Defined in src/channel.ts:66

getProperty

getProperty(path: string | string[]): Promise<any>
Gets a property value from the remote API
Parameters
- path: string | string[]
  The property path (dot notation string or array)
Returns Promise<any>
Promise that resolves with the property value
- Defined in src/channel.ts:179

setProperty

setProperty(path: string | string[], value: any): Promise<void>
Sets a property value on the remote API
Parameters
- path: string | string[]
  The property path (dot notation string or array)
- value: any
  The value to set
Returns Promise<void>
Promise that resolves when the property is set
- Defined in src/channel.ts:202

Class RPCChannel<LocalAPI, RemoteAPI, Io>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RPCChannel<LocalAPI, RemoteAPI, Io>

Methods

callConstructor

Type Parameters

Parameters

Returns Promise<any>

callMethod

Type Parameters

Parameters

Returns Promise<void>

expose

Parameters

Returns void

freeCallbacks

Returns void

getAPI

Returns RemoteAPI

getIO

Returns Io

getProperty

Parameters

Returns Promise<any>

setProperty

Parameters

Returns Promise<void>

Settings

On This Page