Module: @socketdb/client
Functions
SocketDBClient
▸ SocketDBClient<Schema>(«destructured»?): SocketDBClientAPI<Schema>
Type parameters
| Name | Type |
|---|---|
Schema | extends Json = any |
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› plugins? | ClientPlugin[] |
› socketClient? | SocketClient |
› store? | Store |
› updateInterval? | number |
Returns
SocketDBClientAPI<Schema>
Defined in
client/src/lib/client.ts:149
createWebsocketClient
▸ createWebsocketClient(«destructured»?): DefaultWebsocketClient
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› protocols? | string[] |
› reconnectTimeout? | number |
Returns
DefaultWebsocketClient
Defined in
client/src/lib/socket-implementation/websocketClient.ts:22
Type Aliases
ChainReference
Ƭ ChainReference<Schema>: Object
Type parameters
| Name | Type |
|---|---|
Schema | extends SchemaDefinition = any |
Type declaration
| Name | Type |
|---|---|
delete | () => void |
each | (callback: (ref: ChainReference<Schema extends Json ? Schema[keyof Schema] : never>, key: keyof Schema) => void) => Unsubscriber |
on | (callback: (data: Schema | null, meta?: Meta) => void) => Unsubscriber |
once | (callback: (data: Schema | null, meta?: Meta) => void) => Unsubscriber |
set | (value: Schema, meta?: Meta) => ChainReference<Schema> |
subscribeGroup | (callback: (ref: ChainReference<Schema>) => void) => Unsubscriber |
get | <Key>(path: Schema extends Json ? Key : never) => ChainReference<Schema extends Json ? Schema[Key] : never> |
Defined in
client/src/lib/client.ts:54
ClientPlugin
Ƭ ClientPlugin: Plugin<ClientHooks>
Defined in
client/src/lib/client.ts:147
SocketDBClientAPI
Ƭ SocketDBClientAPI<Schema>: { connect: (url?: string) => void ; disconnect: () => void ; intercept: <Hook>(hook: Hook, callback: ClientHooks[Hook]) => () => void } & ChainReference<Schema>
Type parameters
| Name | Type |
|---|---|
Schema | extends SchemaDefinition = any |
Defined in
client/src/lib/client.ts:40