Class StringSchema<T>

Schema to encode an byte string or an Utf8 string in TLV.

See

MatterSpecification.v10.Core § A.11.2

Type Parameters

T extends ByteString | Utf8String

Hierarchy (view full)

TlvSchema<TlvToPrimitive[T]>
- StringSchema

Index

Constructors

Properties

maxLength minLength

Methods

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

Constructors

constructor

new StringSchema<T>(type, minLength?, maxLength?): StringSchema<T>
Type Parameters
- T extends Utf8String | ByteString
Parameters
- type: T
- minLength: number = 0
- maxLength: number = 1024
Returns StringSchema<T>
Overrides TlvSchema<TlvToPrimitive[T]>.constructor
- Defined in packages/types/src/tlv/TlvString.ts:24

Properties

`Readonly`maxLength

maxLength: number = 1024

`Readonly`minLength

minLength: number = 0

Methods

bound

bound(__namedParameters): StringSchema<T>
Parameters
- __namedParameters: LengthConstraints
Returns StringSchema<T>
- Defined in packages/types/src/tlv/TlvString.ts:60

decode

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

decodeInternal

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

decodeTlv

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

decodeTlvInternal

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

decodeTlvInternalValue

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

encode

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

encodeInternal

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

encodeTlv

encodeTlv(value, options?): TlvStream
Parameters
- value: TlvToPrimitive[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: TlvToPrimitive[T]
- Optionaltag: TlvTag
Returns void
Overrides TlvSchema.encodeTlvInternal
- Defined in packages/types/src/tlv/TlvString.ts:34

injectField

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

removeField

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