@delight-rpc/piscina

Install

1npm install --save @delight-rpc/piscina
2# or
3yarn add @delight-rpc/piscina

Usage

1// api.d.ts
2interface IAPI {
3  echo(message: string): string
4}
5
6// worker.ts
7import { createServer } from '@delight-rpc/piscina'
8
9const api: IAPI = {
10  echo(message: string): string {
11    return message
12  }
13}
14
15export default createServer(api)
16
17// main.ts
18import { createClient } from '@delight-rpc/piscina'
19
20const piscina = new Piscina({
21  filename: new URL('./worker.js', import.meta.url).href
22})
23const client = createClient<IAPI>(piscina)
24
25await client.echo('hello world')

API

createClient

1function createClient<IAPI extends object>(
2  piscina: Piscina
3, options?: {
4    parameterValidators?: DelightRPC.ParameterValidators<IAPI>
5    expectedVersion?: string
6    channel?: string
7  }
8): DelightRPC.ClientProxy<IAPI>

createBatchClient

1function createBatchClient<DataType>(
2  piscina: Piscina
3, options?: {
4    expectedVersion?: string
5    channel?: string
6  }
7): DelightRPC.BatchClient<DataType>

createServer

1function createServer<IAPI extends object>(
2  api: DelightRPC.ImplementationOf<IAPI>
3, options?: {
4    parameterValidators?: DelightRPC.ParameterValidators<IAPI>
5    version?: `${number}.${number}.${number}`
6    channel?: string
7    ownPropsOnly?: boolean
8    channel?: string | RegExp | AnyChannel
9  }
10): (req: unknown) => Promise<unknown>