open
Allows you to open the Pricing connection by sending corresponding requests for all requested instruments.
It will be opened once all the requested instruments are received either a Refresh or a Status event.
Then the Pricing.Stream can be used in order to retrieve data.
Syntax
stream.open(params: Pricing.OpenStreamParams)
Parameters
| Value | Description | Data type | Optional | Default value |
|---|---|---|---|---|
| params | An object literal of type Pricing.OpenStreamParams | object | No | - |
Pricing.OpenStreamParams properties:
| Value | Description | Data type | Optional | Default value |
|---|---|---|---|---|
| withUpdates | If true - the streaming will work as usual and the data will be received continuously. If false only one data snapshot will be received and stream will be closed automatically |
boolean | Yes | true |
Returned value
Promise<Pricing.Stream> a Promise with the current pricing stream instance`
Usage
The following example demonstrates how to create and open a pricing stream.
const stream = Pricing.Definition(['EUR=']).getStream();
await stream.open();
Related Links
None.