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)

TlvSchema<T[]>
- ArraySchema

Index

Constructors

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>
- minLength: number = 0
- maxLength: number = 65535
Returns ArraySchema<T>
Overrides TlvSchema<T[]>.constructor
- Defined in packages/types/src/tlv/TlvArray.ts:34

Properties

`Readonly`elementSchema

elementSchema: TlvSchema<T>

`Readonly`maxLength

maxLength: number = 65535

`Readonly`minLength

minLength: number = 0

Methods

decode

decode(encoded, validate?): T[]
Decodes the encoded data using the schema.
Parameters
- encoded: Uint8Array
- validate: boolean = true
Returns T[]
Inherited from TlvSchema.decode
- Defined in packages/types/src/schema/Schema.ts:16

decodeFromChunkedArray

decodeFromChunkedArray(chunks, currentValue?): T[]
Parameters
- chunks: ArrayAsChunked
- OptionalcurrentValue: T[]
Returns T[]
- Defined in packages/types/src/tlv/TlvArray.ts:106

decodeInternal

decodeInternal(encoded): T[]
Parameters
- encoded: Uint8Array
Returns T[]
Inherited from TlvSchema.decodeInternal
- Defined in packages/types/src/tlv/TlvSchema.ts:26

decodeTlv

decodeTlv(encoded): T[]
Parameters
- encoded: TlvStream
Returns T[]
Inherited from TlvSchema.decodeTlv
- Defined in packages/types/src/tlv/TlvSchema.ts:42

decodeTlvInternal

decodeTlvInternal(reader): {
tag?: TlvTag;
value: T[];
}
Parameters
- reader: TlvReader
Returns {
tag?: TlvTag;
value: T[];
}
- Optionaltag?: TlvTag
- value: T[]
Inherited from TlvSchema.decodeTlvInternal
- Defined in packages/types/src/tlv/TlvSchema.ts:46

decodeTlvInternalValue

decodeTlvInternalValue(reader, typeLength): T[]
Parameters
- reader: TlvReader
- typeLength: TlvTypeLength
Returns T[]
Overrides TlvSchema.decodeTlvInternalValue
- Defined in packages/types/src/tlv/TlvArray.ts:48

encode

encode(value): Uint8Array
Encodes the value using the schema.
Parameters
- value: T[]
Returns Uint8Array
Inherited from TlvSchema.encode
- Defined in packages/types/src/schema/Schema.ts:10

encodeAsChunkedArray

encodeAsChunkedArray(value): ArrayAsChunked
Parameters
- value: T[]
Returns ArrayAsChunked
- Defined in packages/types/src/tlv/TlvArray.ts:132

encodeInternal

encodeInternal(value): Uint8Array
Parameters
- value: T[]
Returns Uint8Array
Inherited from TlvSchema.encodeInternal
- Defined in packages/types/src/tlv/TlvSchema.ts:30

encodeTlv

encodeTlv(value, options?): TlvStream
Parameters
- value: T[]
- Optionaloptions: TlvEncodingOptions
Returns TlvStream
Inherited from TlvSchema.encodeTlv
- Defined in packages/types/src/tlv/TlvSchema.ts:36

encodeTlvInternal

encodeTlvInternal(writer, value, tag?, options?): void
Parameters
- writer: TlvWriter
- value: T[]
- Optionaltag: TlvTag
- Optionaloptions: TlvEncodingOptions
Returns void
Overrides TlvSchema.encodeTlvInternal
- Defined in packages/types/src/tlv/TlvArray.ts:42

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[]
Overrides TlvSchema.injectField
- Defined in packages/types/src/tlv/TlvArray.ts:61

removeField

removeField(value, fieldId, removeChecker): T[]
Parameters
- value: T[]
- fieldId: number
- removeChecker: ((fieldValue: any) => boolean)
  - - (fieldValue): boolean
    - Parameters
      fieldValue: any
      Returns boolean
Returns T[]
Overrides TlvSchema.removeField
- Defined in packages/types/src/tlv/TlvArray.ts:76

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
Overrides TlvSchema.validate
- Defined in packages/types/src/tlv/TlvArray.ts:85