Class NullableSchema<T>

Schema to encode a nullable value in TLV.

See

MatterSpecification.v10.Core § A.11.6

Type Parameters

  • T

Hierarchy (view full)

Constructors

constructor

Methods

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

Constructors

constructor

  • new NullableSchema<T>(schema): NullableSchema<T>

  • Type Parameters

    • T

    Parameters

    Returns NullableSchema<T>

Methods

decode

  • decode(encoded, validate?): null | T

  • Decodes the encoded data using the schema.

    Parameters

    • encoded: Uint8Array
    • Optionalvalidate: boolean

    Returns null | T

decodeInternal

  • decodeInternal(encoded): null | T

  • Parameters

    • encoded: Uint8Array

    Returns null | T

decodeTlv

  • decodeTlv(encoded): null | T

  • Parameters

    Returns null | T

decodeTlvInternal

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

  • Parameters

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

    • Optionaltag?: TlvTag
    • value: null | T

decodeTlvInternalValue

  • decodeTlvInternalValue(reader, typeLength): null | T

  • Parameters

    Returns null | T

encode

  • encode(value): Uint8Array

  • Encodes the value using the schema.

    Parameters

    • value: null | T

    Returns Uint8Array

encodeInternal

  • encodeInternal(value): Uint8Array

  • Parameters

    • value: null | T

    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): 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: null | T

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods