Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Variant

A value with alternative representations.

Example:

{
    constructor: 'SomeVariant',
    value: {
        valueType: 'record',
        fields: {
            a: { valueType: 'bool', bool: true },
            b: { valueType: 'int64', int64: '42' }
        }
    }
}

To express values in a more concise way, you can have a look at the ValueHelpers.

see

Identifier

see

Value

Hierarchy

Index

Properties

constructor

constructor: string

Determines which of the variant's alternatives is encoded in this message.

value

value: Value

The value encoded within the Variant.

Optional variantId

variantId: Identifier

Omitted from the transaction stream when verbose streaming is not enabled.

Optional when submitting commands.

Generated using TypeDoc