0.4.3 • Published 2 years ago
@delight-rpc/websocket-browser v0.4.3
@delight-rpc/websocket-browser
Install
npm install --save @delight-rpc/websocket-browser
# or
yarn add @delight-rpc/websocket-browser
API
createClient
function createClient<IAPI extends object>(
socket: WebSocket
, options?: {
parameterValidators?: DelightRPC.ParameterValidators<IAPI>
expectedVersion?: `${number}.${number}.${number}`
channel?: string
timeout?: number
}
): [client: DelightRPC.ClientProxy<IAPI>, close: () => void]
createBatchClient
function createBatchClient(
socket: WebSocket
, options?: {
expectedVersion?: `${number}.${number}.${number}`
channel?: string
timeout?: number
}
): [client: DelightRPC.BatchClient, close: () => void]
createServer
function createServer<IAPI extends object>(
api: DelightRPC.ImplementationOf<IAPI>
, socket: WebSocket
, options?: {
parameterValidators?: DelightRPC.ParameterValidators<IAPI>
version?: `${number}.${number}.${number}`
channel?: string | RegExp | AnyChannel
ownPropsOnly?: boolean
}
): () => void