Class Variant

Hierarchy (view full)

Constructors

constructor

Properties

arrayType dataType dimensions schema value coerce computer_default_value maxArrayLength maxTypedArrayLength schema

Methods

applyOnAllFields binaryStoreSize clone decode decodeDebug encode explore isValid toJSON toString

Constructors

constructor

  • new Variant(options?): Variant

  • Parameters

    Returns Variant

Properties

arrayType

arrayType: VariantArrayType

dataType

dataType: DataType

dimensions

dimensions: null | number[]

schema

schema: IStructuredTypeSchema

value

value: any

Staticcoerce

coerce: ((variantLike: VariantOptions | Variant) => Variant)

Staticcomputer_default_value

computer_default_value: (() => Variant)

StaticmaxArrayLength

maxArrayLength: number

StaticmaxTypedArrayLength

maxTypedArrayLength: number

Staticschema

schema: IStructuredTypeSchema

Methods

applyOnAllFields

  • applyOnAllFields<T>(func, data): void

  • Type Parameters

    • T

    Parameters

    • func: Func1<T>
    • data: T

    Returns void

binaryStoreSize

  • binaryStoreSize(): number

  • Calculate the required size to store this object in a binary stream.

    Returns number

clone

  • clone(): Variant

  • Returns Variant

decode

  • decode(stream): void

  • Decode the object from the binary stream.

    Parameters

    Returns void

decodeDebug

  • decodeDebug(stream, options): void

  • Parameters

    Returns void

encode

  • encode(stream): void

  • Encode the object to the binary stream.

    Parameters

    • stream: OutputBinaryStream

    Returns void

explore

  • explore(): string

  • Returns string

isValid

  • isValid(): boolean

  • verify that all object attributes values are valid according to schema

    Returns boolean

toJSON

  • toJSON(): any

  • Returns any

toString

  • toString(): string

  • Returns string

Settings

Member Visibility

On This Page

Constructors
Properties
Methods