LSEG Data Library for TypeScript

Built with Pandora

HistoricalPricing.Metadata.Global.Definition object

This object creates the definition of information about particular global metadata that we want to retrieve.

Syntax

HistoricalPricing.Metadata.Global.Definition(params: HistoricalPricing.Metadata.Global.Params)

Parameters

Value Description Data type Optional Default value
params An object literal of type HistoricalPricing.Metadata.Global.Params object No -

HistoricalPricing.Metadata.Instrument.Params properties

Value Description Data type Optional Default value
types List of metadata fields Types[] or string Yes -
extendedParams Additional parameters to apply to the request object Yes -

Possible values for the types paramater are the following:

Types =
| 'DerivationRules'
| 'FilterActionRules'
| 'TimeZones'
| 'MultipleFieldMapping'
| 'MasterMapping'
| 'Exchanges'
| 'Currencies'
| 'Units'

Returned value

ContentDefinition object.

Usage

The following example demonstrates how to create a historical pricing metadata global definition object for retrieving global metadata for TimeZones type.

import { HistoricalPricing } from '@lsegroup/data';

const definition = HistoricalPricing.Metadata.Global.Definition({
    types: ['TimeZones']
});

`
113 words (0:36 mins)