Class TlvWrapper<O, T>

Type Parameters

  • O
  • T

Hierarchy (view full)

Constructors

constructor

Properties

underlyingSchema wrap

Methods

decode decodeInternal decodeTlv decodeTlvInternal decodeTlvInternalValue encode encodeInternal encodeTlv encodeTlvInternal injectField removeField validate

Constructors

constructor

  • new TlvWrapper<O, T>(underlyingSchema, wrap, unwrap): TlvWrapper<O, T>

  • Type Parameters

    • O
    • T

    Parameters

    • underlyingSchema: TlvSchema<T>
    • wrap: ((object: O) => T)
        • (object): T

        • Parameters

          • object: O

          Returns T

    • unwrap: ((value: T) => O)
        • (value): O

        • Parameters

          • value: T

          Returns O

    Returns TlvWrapper<O, T>

Properties

Protected ReadonlyunderlyingSchema

underlyingSchema: TlvSchema<T>

Protected Readonlywrap

wrap: ((object: O) => T)

Methods

decode

  • decode(encoded, validate?): O

  • Decodes the encoded data using the schema.

    Parameters

    • encoded: Uint8Array
    • Optionalvalidate: boolean

    Returns O

decodeInternal

  • decodeInternal(encoded): O

  • Parameters

    • encoded: Uint8Array

    Returns O

decodeTlv

  • decodeTlv(encoded): O

  • Parameters

    Returns O

decodeTlvInternal

  • decodeTlvInternal(reader): {
        tag?: TlvTag;
        value: O;
    }

  • Parameters

    Returns {
        tag?: TlvTag;
        value: O;
    }

decodeTlvInternalValue

  • decodeTlvInternalValue(reader, typeLength): O

  • Parameters

    Returns O

encode

  • encode(value): Uint8Array

  • Encodes the value using the schema.

    Parameters

    • value: O

    Returns Uint8Array

encodeInternal

  • encodeInternal(value): Uint8Array

  • Parameters

    • value: O

    Returns Uint8Array

encodeTlv

  • encodeTlv(value, options?): TlvStream

  • Parameters

    Returns TlvStream

encodeTlvInternal

  • encodeTlvInternal(writer, value, tag?, options?): void

  • Parameters

    Returns void

injectField

  • injectField(value, _fieldId, _fieldValue, _injectChecker): O

  • Parameters

    • value: O
    • _fieldId: number
    • _fieldValue: any
    • _injectChecker: ((fieldValue: any) => boolean)
        • (fieldValue): boolean

        • Parameters

          • fieldValue: any

          Returns boolean

    Returns O

removeField

  • removeField(value, _fieldId, _removeChecker): O

  • Parameters

    • value: O
    • _fieldId: number
    • _removeChecker: ((fieldValue: any) => boolean)
        • (fieldValue): boolean

        • Parameters

          • fieldValue: any

          Returns boolean

    Returns O

validate

  • validate(value): void

  • Optional validator that can be used to enforce constraints on the data before encoding / after decoding.

    Parameters

    • value: O

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods