Refinitiv Data Library for TypeScript

RDPStream.Definition

Summary

This method creates a Definition that can be used to get RDPStream that can be used to subscribe to streaming items of any Domain Model of the Refinitiv Data Platform.

Methods

RDPStream.Definition(universe: string)

Allows you to create a short definition for RDPStream

Parameters:

Property Is Optional Default Value Type Description
universe No Defined within the streaming platform string Universe of the streaming instrument

Returned value: a new instance of RDPStream Definition.

RDPStream.Definition(params?: RDPStreamRequestParams)

Allows you to create a full definition for RDPStream

Parameters:

Property Is Optional Default Value Type Description
universe No Defined within the streaming platform string Universe of the streaming instrument
service Yes Defined within the streaming platform string Offers the ability to use specific service to manage the real-time streaming data
context Yes Defined within the streaming platform string Defines the context for the specific data of interest
api Yes trading-analytics/redi Specifies the data source. It can be updated/added using config file
fields Yes All fields string[] Specifies the specific fields delivered when messages arrive
parameters Yes - object Specifies the additional request parameters
extendedParams Yes - {[key:string]:any} Specifies the parameters that will be merged with the request

Returned value: a new instance of RDPStream Definition.

getStream(session: Session)

Parameters:

Property Is Optional Default Value Type Description
session No - Session The Session used by the RDPStream to retrieve data from the platform

Returned value: a RDPStream that uses the given session.

Example of usage

const rdpStream = RDPStream.Definition(
    {
        universe: 'RBH0',
        parameters: { instrumentType: 'RIC' }
    }
).getStream(session);