Class BooleanSchema

Schema to encode a boolean in TLV.

See

MatterSpecification.v10.Core § A.11.3

Hierarchy (view full)

TlvSchema<boolean>
- BooleanSchema

Index

Constructors

Methods

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

Constructors

constructor

new BooleanSchema(): BooleanSchema
Returns BooleanSchema
Inherited from TlvSchema<boolean>.constructor

Methods

decode

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

decodeInternal

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

decodeTlv

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

decodeTlvInternal

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

decodeTlvInternalValue

decodeTlvInternalValue(_reader, typeLength): boolean
Parameters
- _reader: TlvReader
- typeLength: TlvTypeLength
Returns boolean
Overrides TlvSchema.decodeTlvInternalValue
- Defined in packages/types/src/tlv/TlvBoolean.ts:22

encode

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

encodeInternal

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

encodeTlv

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

encodeTlvInternal

encodeTlvInternal(writer, value, tag?): void
Parameters
- writer: TlvWriter
- value: boolean
- Optionaltag: TlvTag
Returns void
Overrides TlvSchema.encodeTlvInternal
- Defined in packages/types/src/tlv/TlvBoolean.ts:18

injectField

injectField(value, _fieldId, _fieldValue, _injectChecker): boolean
Parameters
- value: boolean
- _fieldId: number
- _fieldValue: any
- _injectChecker: ((fieldValue: any) => boolean)
  - - (fieldValue): boolean
    - Parameters
      fieldValue: any
      Returns boolean
Returns boolean
Inherited from TlvSchema.injectField
- Defined in packages/types/src/tlv/TlvSchema.ts:55

removeField

removeField(value, _fieldId, _removeChecker): boolean
Parameters
- value: boolean
- _fieldId: number
- _removeChecker: ((fieldValue: any) => boolean)
  - - (fieldValue): boolean
    - Parameters
      fieldValue: any
      Returns boolean
Returns boolean
Inherited from TlvSchema.removeField
- Defined in packages/types/src/tlv/TlvSchema.ts:59

validate

validate(value): void
Optional validator that can be used to enforce constraints on the data before encoding / after decoding.
Parameters
- value: boolean
Returns void
Overrides TlvSchema.validate
- Defined in packages/types/src/tlv/TlvBoolean.ts:27