Class TlvNumericSchema<T>

Schema to encode an unsigned integer in TLV.

See

MatterSpecification.v10.Core § A.11.1

Type Parameters

T extends bigint | number

Hierarchy (view full)

TlvSchema<T>
- TlvNumericSchema
  - TlvNumberSchema

Index

Constructors

Properties

lengthProvider max? min? type

Methods

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

Constructors

constructor

new TlvNumericSchema<T>(type, lengthProvider, min?, max?): TlvNumericSchema<T>
Type Parameters
- T extends number | bigint
Parameters
- type: SignedInt | UnsignedInt | Float
- lengthProvider: ((value: T) => TlvLength)
  - - (value): TlvLength
    - Parameters
      value: T
      Returns TlvLength
- Optionalmin: T
- Optionalmax: T
Returns TlvNumericSchema<T>
Overrides TlvSchema<T>.constructor
- Defined in packages/types/src/tlv/TlvNumber.ts:39

Properties

`Protected` `Readonly`lengthProvider

lengthProvider: ((value: T) => TlvLength)

`Protected` `Optional` `Readonly`max

max?: T

`Protected` `Optional` `Readonly`min

min?: T

`Protected` `Readonly`type

type: SignedInt | UnsignedInt | Float

Methods

bound

bound(__namedParameters): TlvNumericSchema<T>
Restrict value range.
Parameters
- __namedParameters: NumericConstraints<T>
Returns TlvNumericSchema<T>
- Defined in packages/types/src/tlv/TlvNumber.ts:74

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

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/TlvNumber.ts:54

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

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?): void
Parameters
- writer: TlvWriter
- value: T
- Optionaltag: TlvTag
Returns void
Overrides TlvSchema.encodeTlvInternal
- Defined in packages/types/src/tlv/TlvNumber.ts:48

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
Inherited from TlvSchema.injectField
- Defined in packages/types/src/tlv/TlvSchema.ts:55

removeField

removeField(value, _fieldId, _removeChecker): T
Parameters
- value: T
- _fieldId: number
- _removeChecker: ((fieldValue: any) => boolean)
  - - (fieldValue): boolean
    - Parameters
      fieldValue: any
      Returns boolean
Returns T
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: T
Returns void
Overrides TlvSchema.validate
- Defined in packages/types/src/tlv/TlvNumber.ts:60

validateBoundaries

validateBoundaries(value): void
Parameters
- value: T
Returns void
- Defined in packages/types/src/tlv/TlvNumber.ts:66