defineSeriesInstrument

defineSeriesInstrument<TItems, TLanguage>(def): object

Defined in: packages/runtime-core/lib/define.d.ts:29

Type Parameters

TItems

TItems extends readonly ScalarInstrumentInternal[]

TLanguage

TLanguage extends InstrumentLanguage

Parameters

def

Omit<{ __runtimeVersion: 1; clientDetails?: ClientInstrumentDetails<TLanguage>; content: Content<TItems[number]["name"], any>; details: InstrumentDetails<TLanguage>; id?: string; internal?: undefined; kind: "SERIES"; language: TLanguage; tags: InstrumentUIOption<TLanguage, string[]>; }, "__runtimeVersion" | "content"> & object

Returns

__runtimeVersion

__runtimeVersion: 1

The runtime version for this instrument, which is set automatically by the defineInstrument function

clientDetails?

optional clientDetails?: ClientInstrumentDetails<TLanguage>

The content in the instrument to be rendered to the client

content

content: Content<TItems[number]["name"], any>

details

details: InstrumentDetails<TLanguage>

The details of the instrument to be displayed to the user

id?

optional id?: string

The database ID for the instrument. For scalar instruments, this is derived by the internal property.

internal?

optional internal?: undefined

kind

kind: "SERIES"

language

language: TLanguage

The language(s) in which the instrument is written