Interface TVariant<T>

interface TVariant<T> {
    arrayType: VariantArrayType;
    dataType: DataType;
    dimensions: null | number[];
    schema: IStructuredTypeSchema;
    value: T;
    applyOnAllFields<T>(func: Func1<T>, data: T): void;
    binaryStoreSize(): number;
    clone(): Variant;
    decode(stream: BinaryStream): void;
    decodeDebug(stream: BinaryStream, options: DecodeDebugOptions): void;
    encode(stream: OutputBinaryStream): void;
    explore(): string;
    isValid(): boolean;
    toJSON(): any;
    toString(): string;
}

Type Parameters

  • T

Hierarchy (view full)

Properties

arrayType dataType dimensions schema value

Methods

applyOnAllFields binaryStoreSize clone decode decodeDebug encode explore isValid toJSON toString

Properties

arrayType

arrayType: VariantArrayType

dataType

dataType: DataType

dimensions

dimensions: null | number[]

schema

schema: IStructuredTypeSchema

value

value: T

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

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

Properties
Methods