Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DataType<ValueType, SourceType, CBORType>

Type parameters

  • ValueType

  • SourceType

  • CBORType

Hierarchy

Index

Methods

Methods

canReadAs

  • canReadAs(valueType: object): boolean

  • Parameters

    • valueType: object

    Returns boolean

    true if a binary representation created by this data type can read as an instance * of valueType

deltaType

  • deltaType(name?: undefined | string): DeltaType<ValueType, SourceType, CBORType>

  • Parameters

    • Optional name: undefined | string

    Returns DeltaType<ValueType, SourceType, CBORType>

    the delta type

name

  • name(): string

  • Returns string

    the name of this datatype

readAs

  • readAs<T>(valueType: object, buffer: Uint8Array, offset?: undefined | number, length?: undefined | number): T | null
  • readAs<T>(valueType: object, buffer: CBORType): T | null

  • Type parameters

    • T

    Parameters

    • valueType: object
    • buffer: Uint8Array
    • Optional offset: undefined | number
    • Optional length: undefined | number

    Returns T | null

    the value in the form of the specified type

  • Type parameters

    • T

    Parameters

    • valueType: object
    • buffer: CBORType

    Returns T | null

readValue

  • readValue(input: Uint8Array, offset?: undefined | number, length?: undefined | number): ValueType | null
  • readValue(input: CBORType): ValueType | null

  • Parameters

    • input: Uint8Array
    • Optional offset: undefined | number
    • Optional length: undefined | number

    Returns ValueType | null

    an instance of this data type value

  • Parameters

    • input: CBORType

    Returns ValueType | null

writeValue

  • writeValue(value: SourceType | undefined | null): Buffer

  • Parameters

    • value: SourceType | undefined | null

    Returns Buffer

    the serialised value as a buffer

writeValueToArray

  • writeValueToArray(value: SourceType | undefined | null): Uint8Array

  • Parameters

    • value: SourceType | undefined | null

    Returns Uint8Array

    the serialised value as a buffer