Class ObjectSchema<F>

Schema to encode an object in TLV.

See

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

Type Parameters

F extends TlvFields

Hierarchy (view full)

TlvSchema<TypeFromFields<F>>
- ObjectSchema
  - ObjectSchemaWithMaxSize

Index

Constructors

Methods

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

Constructors

constructor

new ObjectSchema<F>(fieldDefinitions, type?, allowProtocolSpecificTags?): ObjectSchema<F>
Type Parameters
- F extends TlvFields
Parameters
- fieldDefinitions: F
- Optionaltype: Structure | List
- OptionalallowProtocolSpecificTags: boolean
Returns ObjectSchema<F>
Overrides TlvSchema<TypeFromFields<F>>.constructor
- Defined in packages/types/dist/esm/tlv/TlvObject.d.ts:57

Methods

decode

decode(encoded, validate?): TypeFromFields<F>
Decodes the encoded data using the schema.
Parameters
- encoded: Uint8Array
- Optionalvalidate: boolean
Returns TypeFromFields<F>
Inherited from TlvSchema.decode
- Defined in packages/types/dist/esm/schema/Schema.d.ts:11

decodeInternal

decodeInternal(encoded): TypeFromFields<F>
Parameters
- encoded: Uint8Array
Returns TypeFromFields<F>
Inherited from TlvSchema.decodeInternal
- Defined in packages/types/dist/esm/tlv/TlvSchema.d.ts:21

decodeTlv

decodeTlv(encoded): TypeFromFields<F>
Parameters
- encoded: TlvStream
Returns TypeFromFields<F>
Inherited from TlvSchema.decodeTlv
- Defined in packages/types/dist/esm/tlv/TlvSchema.d.ts:24

decodeTlvInternal

decodeTlvInternal(reader): {
tag?: TlvTag;
value: TypeFromFields<F>;
}
Parameters
- reader: TlvReader
Returns {
tag?: TlvTag;
value: TypeFromFields<F>;
}
- Optionaltag?: TlvTag
- value: TypeFromFields<F>
Inherited from TlvSchema.decodeTlvInternal
- Defined in packages/types/dist/esm/tlv/TlvSchema.d.ts:25

decodeTlvInternalValue

decodeTlvInternalValue(reader, typeLength): TypeFromFields<F>
Parameters
- reader: TlvReader
- typeLength: TlvTypeLength
Returns TypeFromFields<F>
Overrides TlvSchema.decodeTlvInternalValue
- Defined in packages/types/dist/esm/tlv/TlvObject.d.ts:59

encode

encode(value): Uint8Array
Encodes the value using the schema.
Parameters
- value: TypeFromFields<F>
Returns Uint8Array
Inherited from TlvSchema.encode
- Defined in packages/types/dist/esm/schema/Schema.d.ts:9

encodeInternal

encodeInternal(value): Uint8Array
Parameters
- value: TypeFromFields<F>
Returns Uint8Array
Inherited from TlvSchema.encodeInternal
- Defined in packages/types/dist/esm/tlv/TlvSchema.d.ts:22

encodeTlv

encodeTlv(value, options?): TlvStream
Parameters
- value: TypeFromFields<F>
- Optionaloptions: TlvEncodingOptions
Returns TlvStream
Inherited from TlvSchema.encodeTlv
- Defined in packages/types/dist/esm/tlv/TlvSchema.d.ts:23

encodeTlvInternal

encodeTlvInternal(writer, value, tag?, options?): void
Parameters
- writer: TlvWriter
- value: TypeFromFields<F>
- Optionaltag: TlvTag
- Optionaloptions: TlvEncodingOptions
Returns void
Overrides TlvSchema.encodeTlvInternal
- Defined in packages/types/dist/esm/tlv/TlvObject.d.ts:58

injectField

injectField(value, fieldId, fieldValue, injectChecker): TypeFromFields<F>
Parameters
- value: TypeFromFields<F>
- fieldId: number
- fieldValue: any
- injectChecker: ((fieldValue: any) => boolean)
  - - (fieldValue): boolean
    - Parameters
      fieldValue: any
      Returns boolean
Returns TypeFromFields<F>
Overrides TlvSchema.injectField
- Defined in packages/types/dist/esm/tlv/TlvObject.d.ts:61

removeField

removeField(value, fieldId, removeChecker): TypeFromFields<F>
Parameters
- value: TypeFromFields<F>
- fieldId: number
- removeChecker: ((fieldValue: any) => boolean)
  - - (fieldValue): boolean
    - Parameters
      fieldValue: any
      Returns boolean
Returns TypeFromFields<F>
Overrides TlvSchema.removeField
- Defined in packages/types/dist/esm/tlv/TlvObject.d.ts:62

validate

validate(value): void
Optional validator that can be used to enforce constraints on the data before encoding / after decoding.
Parameters
- value: TypeFromFields<F>
Returns void
Overrides TlvSchema.validate
- Defined in packages/types/dist/esm/tlv/TlvObject.d.ts:60