Class TlvNumericSchema<T>

Schema to encode an unsigned integer in TLV.

See

MatterSpecification.v10.Core § A.11.1

Type Parameters

  • T extends bigint | number

Hierarchy (view full)

Constructors

constructor

Properties

lengthProvider max? min? type

Methods

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

Constructors

constructor

Properties

Protected ReadonlylengthProvider

lengthProvider: ((value: T) => TlvLength)

Protected Optional Readonlymax

max?: T

Protected Optional Readonlymin

min?: T

Protected Readonlytype

type: SignedInt | UnsignedInt | Float

Methods

bound

decode

  • decode(encoded, validate?): T

  • Decodes the encoded data using the schema.

    Parameters

    • encoded: Uint8Array
    • Optionalvalidate: boolean

    Returns T

decodeInternal

  • decodeInternal(encoded): T

  • Parameters

    • encoded: Uint8Array

    Returns T

decodeTlv

  • decodeTlv(encoded): T

  • Parameters

    Returns T

decodeTlvInternal

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

  • Parameters

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

decodeTlvInternalValue

  • decodeTlvInternalValue(reader, typeLength): T

  • Parameters

    Returns T

encode

  • encode(value): Uint8Array

  • Encodes the value using the schema.

    Parameters

    • value: T

    Returns Uint8Array

encodeInternal

  • encodeInternal(value): Uint8Array

  • Parameters

    • value: T

    Returns Uint8Array

encodeTlv

  • encodeTlv(value, options?): TlvStream

  • Parameters

    Returns TlvStream

encodeTlvInternal

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

  • Parameters

    Returns void

injectField

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

  • Parameters

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

        • Parameters

          • fieldValue: any

          Returns boolean

    Returns T

removeField

  • removeField(value, _fieldId, _removeChecker): T

  • Parameters

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

        • Parameters

          • fieldValue: any

          Returns boolean

    Returns T

validate

  • validate(value): void

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

    Parameters

    • value: T

    Returns void

validateBoundaries

  • validateBoundaries(value): void

  • Parameters

    • value: T

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods