Class OptClass<T>

Represents an IDL Option

Param: t

Type Parameters

  • T

Hierarchy (view full)

Constructors

constructor

Properties

_type

Accessors

name

Methods

buildTypeTable checkType encodeType accept covariant encodeValue _buildTypeTableImpl decodeValue display valueToString

Constructors

constructor

  • new OptClass<T>(_type): types.IDL.OptClass<T>

  • Type Parameters

    • T

    Parameters

    Returns types.IDL.OptClass<T>

Properties

Protected _type

_type: types.IDL.Type<T>

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

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: [] | [T]

    Returns ArrayBuffer

_buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

decodeValue

  • decodeValue(b, t): [] | [T]

  • Parameters

    Returns [] | [T]

display

  • display(): string

  • Returns string

valueToString

  • valueToString(x): string

  • Parameters

    • x: [] | [T]

    Returns string

Settings

Member Visibility

Theme

On This Page

constructor_typenamebuildTypeTablecheckTypeencodeTypeacceptcovariantencodeValue_buildTypeTableImpldecodeValuedisplayvalueToString