https://github.com/delight-rpc/websocket
🌲
https://github.com/delight-rpc/websocket
esm library nodejs npm-package typescript
Last synced: 2 months ago
JSON representation
🌲
- Host: GitHub
- URL: https://github.com/delight-rpc/websocket
- Owner: delight-rpc
- License: mit
- Created: 2021-12-02T09:25:02.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-15T08:39:22.000Z (over 2 years ago)
- Last Synced: 2025-07-22T15:46:23.885Z (12 months ago)
- Topics: esm, library, nodejs, npm-package, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@delight-rpc/websocket
- Size: 983 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @delight-rpc/websocket
## Install
```sh
npm install --save @delight-rpc/websocket
# or
yarn add @delight-rpc/websocket
```
## API
### createClient
```ts
function createClient(
socket: WebSocket
, options?: {
parameterValidators?: DelightRPC.ParameterValidators
expectedVersion?: string
channel?: string
timeout?: number
}
): [client: DelightRPC.ClientProxy, close: () => void]
```
### createBatchClient
```ts
function createBatchClient(
socket: WebSocket
, options?: {
expectedVersion?: string
channel?: string
timeout?: number
}
): [client: DelightRPC.BatchClient, close: () => void]
```
### createServer
```ts
function createServer(
api: DelightRPC.ImplementationOf
, socket: WebSocket
, options?: {
loggerLevel?: Level = Level.None
parameterValidators?: DelightRPC.ParameterValidators
version?: `${number}.${number}.${number}`
channel?: string | RegExp | AnyChannel
ownPropsOnly?: boolean
}
): () => void
```