Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RecordV2DataType

Hierarchy

Index

Properties

Methods

Properties

RecordV2

RecordV2: 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

name

  • name(): string

  • Returns string

    the name of this datatype

parseSchema

  • parseSchema(json: string): Schema

  • Parameters

    • json: string

    Returns Schema

    the schema

readAs

  • readAs<T>(valueType: object, buffer: Uint8Array, offset?: undefined | number, length?: undefined | number): T | null
  • readAs<T>(valueType: object, buffer: RecordV2): 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

    Returns T | null

readValue

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

  • Parameters

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

    Returns RecordV2 | null

    an instance of this data type value

  • Parameters

    Returns RecordV2 | null

schemaBuilder

  • Returns SchemaBuilder

    a new schema builder

valueBuilder

  • Returns RecordV2Builder

    a new records builder

withSchema

writeValue

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

  • Parameters

    Returns Buffer

    the serialised value as a buffer

writeValueToArray

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

  • Parameters

    Returns Uint8Array

    the serialised value as a buffer