Skip to content

ScalarInstrument

ScalarInstrument<TData, TLanguage> = Merge<BaseInstrument<TLanguage>, { defaultMeasureVisibility?: InstrumentMeasureVisibility; internal: ScalarInstrumentInternal; measures: InstrumentMeasures<TData, TLanguage> | null; validationSchema: InstrumentValidationSchema<TData>; }>

Defined in: packages/runtime-core/lib/types/instrument.base.d.ts:154

The basic properties common to all scalar instruments. Specific types of instruments (e.g., form, interactive) extend this type and are discriminated according to the kind property.

Type Parameters

TData

TData = any

the structure of the data derived from this instrument

TLanguage

TLanguage extends InstrumentLanguage = InstrumentLanguage

the language(s) of the instrument