SubscriptionParamsinterface
Optional object with parameters passed to subscribe() when subscribing to a stream.
Properties (7)
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| arguments⚓︎ | object | x | x | A plain JavaScript object (or JSON) holding key/value pairs passed as named arguments to the handler of the registered Interop stream. |
| methodResponseTimeout⚓︎ | number | 30000 | x | Timeout to wait for a stream reply. |
| onClosed⚓︎ | () => void | x | x | Subscribe for the event which fires when the subscription is closed. |
| onConnected⚓︎ | (server: Instance, reconnect: boolean) => void | x | x | Subscribe for the event which your subscription is connected to a server |
| onData⚓︎ | (data: StreamData) => void | x | x | Subscribe for the event which fires when new data is received. |
| target⚓︎ | InstanceTarget | x | x | Specifies which servers to target. Can be one of: "best", "all", |
| waitTimeoutMs⚓︎ | number | 30000 | x | Timeout to discover the stream, if not immediately available. |