Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BinaryDataType

Hierarchy

Index

Properties

Methods

Properties

Binary

Binary: object

Type declaration

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

from

  • from(buffer: Uint8Array): Binary

  • Parameters

    • buffer: Uint8Array

    Returns Binary

    A Binary data-type instance

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: Binary): 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: Binary

    Returns T | null

readValue

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

  • Parameters

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

    Returns Binary | null

    an instance of this data type value

  • Parameters

    Returns Binary | null

writeValue

  • writeValue(value: Uint8Array | Binary | undefined | null): Buffer

  • Parameters

    • value: Uint8Array | Binary | undefined | null

    Returns Buffer

    the serialised value as a buffer

writeValueToArray

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

  • Parameters

    • value: Uint8Array | Binary | undefined | null

    Returns Uint8Array

    the serialised value as a buffer