Class TupleClass<T>

Represents Tuple, a syntactic sugar for Record.

Param: components

Type Parameters

  • T extends any[]

Hierarchy (view full)

Constructors

constructor

Properties

_fields _components

Accessors

name

Methods

buildTypeTable checkType encodeType tryAsTuple _buildTypeTableImpl accept covariant encodeValue decodeValue display valueToString

Constructors

constructor

  • new TupleClass<T>(_components): types.IDL.TupleClass<T>

  • Type Parameters

    • T extends any[]

    Parameters

    Returns types.IDL.TupleClass<T>

Properties

Protected Readonly _fields

_fields: [string, types.IDL.Type<any>][]

Protected Readonly _components

_components: types.IDL.Type<any>[]

Accessors

name

  • get name(): string

  • Returns string

Methods

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

encodeType

  • encodeType(typeTable): ArrayBuffer

  • Implement I in the IDL spec. Encode this type for the type table.

    Parameters

    • typeTable: TypeTable

    Returns ArrayBuffer

tryAsTuple

  • tryAsTuple(): null | types.IDL.Type<any>[]

  • Returns null | types.IDL.Type<any>[]

_buildTypeTableImpl

  • _buildTypeTableImpl(T): void

  • Parameters

    • T: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D
    • R

    Parameters

    Returns R

covariant

  • covariant(x): x is T

  • Assert that JavaScript's x is the proper type represented by this Type.

    Parameters

    • x: any

    Returns x is T

encodeValue

  • encodeValue(x): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by encodeValue() from different types.

    Parameters

    • x: any[]

    Returns ArrayBuffer

decodeValue

  • decodeValue(b, t): T

  • Parameters

    Returns T

display

  • display(): string

  • Returns string

valueToString

  • valueToString(values): string

  • Parameters

    • values: any[]

    Returns string

Settings

Member Visibility

Theme

On This Page

constructor_fields_componentsnamebuildTypeTablecheckTypeencodeTypetryAsTuple_buildTypeTableImplacceptcovariantencodeValuedecodeValuedisplayvalueToString