Class ArraySchema<T>

Schema to encode an array or string in TLV.

See

MatterSpecification.v10.Core § A.11.2 and A.11.4

Type Parameters

  • T

Hierarchy (view full)

Constructors

constructor

Properties

elementSchema maxLength minLength

Methods

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

Constructors

constructor

  • new ArraySchema<T>(elementSchema, minLength?, maxLength?): ArraySchema<T>

  • Type Parameters

    • T

    Parameters

    • elementSchema: TlvSchema<T>
    • OptionalminLength: number
    • OptionalmaxLength: number

    Returns ArraySchema<T>

Properties

ReadonlyelementSchema

elementSchema: TlvSchema<T>

ReadonlymaxLength

maxLength: number

ReadonlyminLength

minLength: number

Methods

decode

  • decode(encoded, validate?): T[]

  • Decodes the encoded data using the schema.

    Parameters

    • encoded: Uint8Array
    • Optionalvalidate: boolean

    Returns T[]

decodeFromChunkedArray

  • decodeFromChunkedArray(chunks, currentValue?): T[]

  • Parameters

    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

encodeAsChunkedArray

encodeInternal

  • encodeInternal(value): Uint8Array

  • Parameters

    • value: 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(data): void

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

    Parameters

    • data: T[]

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods