Class NullableSchema<T>

Schema to encode a nullable value in TLV.

See

MatterSpecification.v10.Core § A.11.6

Type Parameters

T

Hierarchy (view full)

TlvSchema<T | null>
- NullableSchema

Index

Constructors

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
- schema: TlvSchema<T>
Returns NullableSchema<T>
Overrides TlvSchema<T | null>.constructor
- Defined in packages/types/src/tlv/TlvNullable.ts:18

Methods

decode

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

decodeInternal

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

decodeTlv

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

decodeTlvInternal

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

decodeTlvInternalValue

decodeTlvInternalValue(reader, typeLength): null | T
Parameters
- reader: TlvReader
- typeLength: TlvTypeLength
Returns null | T
Overrides TlvSchema.decodeTlvInternalValue
- Defined in packages/types/src/tlv/TlvNullable.ts:30

encode

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

encodeInternal

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

encodeTlv

encodeTlv(value, options?): TlvStream
Parameters
- value: null | 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: null | T
- Optionaltag: TlvTag
- Optionaloptions: TlvEncodingOptions
Returns void
Overrides TlvSchema.encodeTlvInternal
- Defined in packages/types/src/tlv/TlvNullable.ts:22

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/TlvNullable.ts:50

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/TlvNullable.ts:57

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