https://github.com/delight-rpc/extra-native-websocket
🌱
https://github.com/delight-rpc/extra-native-websocket
browser esm library npm-package typescript
Last synced: about 1 year ago
JSON representation
🌱
- Host: GitHub
- URL: https://github.com/delight-rpc/extra-native-websocket
- Owner: delight-rpc
- License: mit
- Created: 2022-05-31T03:09:34.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-05-28T06:28:45.000Z (about 1 year ago)
- Last Synced: 2025-05-28T06:33:45.967Z (about 1 year ago)
- Topics: browser, esm, library, npm-package, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@delight-rpc/extra-native-websocket
- Size: 839 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/extra-native-websocket
## Install
```sh
npm install --save @delight-rpc/extra-native-websocket
# or
yarn add @delight-rpc/extra-native-websocket
```
## API
### createClient
```ts
function createClient(
socket: ExtraNativeWebSocket
, options?: {
parameterValidators?: DelightRPC.ParameterValidators
expectedVersion?: string
channel?: string
timeout?: number
}
): [client: DelightRPC.ClientProxy, close: () => void]
```
### createBatchClient
```ts
function createBatchClient(
socket: ExtraNativeWebSocket
, options?: {
expectedVersion?: string
channel?: string
timeout?: number
}
): [client: DelightRPC.BatchClient, close: () => void]
```
### createServer
```ts
function createServer(
api: DelightRPC.ImplementationOf
, socket: ExtraNativeWebSocket
, options?: {
parameterValidators?: DelightRPC.ParameterValidators
version?: `${number}.${number}.${number}`
channel?: string | RegExp | AnyChannel
ownPropsOnly?: boolean
}
): () => void
```