Pricing.Chain.Definition object
This object creates a definition of information about the specified chains to request and decode them dynamically.
Syntax
Pricing.Chain.Definition(params: Pricing.Chain.Params)
Parameters
| Value | Description | Data type | Optional | Default value |
|---|---|---|---|---|
| params | An object literal of type Pricing.Chain.Params | object | No | - |
Pricing.Chain.Params properties:
| Value | Description | Data type | Optional | Default value |
|---|---|---|---|---|
| name | Name of the instrument | string | No | - |
| service | Service to be used | string | Yes | - |
| nameGuessingQuantity | Indicates the number of Chain Record names to guess in advance | number | Yes | 10 |
| overrideSummaryLinks | Defines quantity of summary links from display template that should be excluded from the response | number | Yes | - |
| skipSummaryLinks | Defines whether summary links should be excluded from the response | boolean | Yes | true |
| skipEmpty | Defines whether empty fields should be skipped in response | boolean | Yes | true |
| api | Connection name to be used for a particular Item Stream | string | Yes | 'streaming/pricing/main' |
| extendedParams | Additional parameters to apply to the request | object | Yes | - |
Returned value
StreamDefinition<Pricing.Chain.Stream> object.
Usage
The following example demonstrates how to create the pricing chain definition for 0#.FTSE.
import { Pricing } from '@refinitiv-data/data';
const definition = Pricing.Chain.Definition('0#FTSE');
`Related Links
None.