Class TlvSchema<T>`Abstract`

Type Parameters

T

Hierarchy (view full)

Schema<T, Uint8Array>
- TlvSchema

Implements

TlvSchema<T>

Implemented by

TlvSchema

Index

Constructors

Methods

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

Constructors

constructor

new TlvSchema<T>(): TlvSchema<T>
Type Parameters
- T
Returns TlvSchema<T>
Inherited from Schema<T, Uint8Array>.constructor

Methods

decode

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

decodeInternal

decodeInternal(encoded): T
Parameters
- encoded: Uint8Array
Returns T
Implementation of TlvSchema.decodeInternal
Overrides Schema.decodeInternal
- Defined in packages/types/src/tlv/TlvSchema.ts:26

decodeTlv

decodeTlv(encoded): T
Parameters
- encoded: TlvStream
Returns T
Implementation of 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
Implementation of TlvSchema.decodeTlvInternal
- Defined in packages/types/src/tlv/TlvSchema.ts:46

`Abstract`decodeTlvInternalValue

decodeTlvInternalValue(reader, typeLength): T
Parameters
- reader: TlvReader
- typeLength: TlvTypeLength
Returns T
Implementation of TlvSchema.decodeTlvInternalValue
- Defined in packages/types/src/tlv/TlvSchema.ts:51

encode

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

encodeInternal

encodeInternal(value): Uint8Array
Parameters
- value: T
Returns Uint8Array
Implementation of TlvSchema.encodeInternal
Overrides Schema.encodeInternal
- Defined in packages/types/src/tlv/TlvSchema.ts:30

encodeTlv

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

`Abstract`encodeTlvInternal

encodeTlvInternal(writer, value, tag?, options?): void
Parameters
- writer: TlvWriter
- value: T
- Optionaltag: TlvTag
- Optionaloptions: TlvEncodingOptions
Returns void
Implementation of TlvSchema.encodeTlvInternal
- Defined in packages/types/src/tlv/TlvSchema.ts:53

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
Implementation of 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
Implementation of 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
Implementation of TlvSchema.validate
Inherited from Schema.validate
- Defined in packages/types/src/schema/Schema.ts:28