Class TlvWrapper<O, T>

Type Parameters

O
T

Hierarchy (view full)

TlvSchema<O>
- TlvWrapper

Index

Constructors

Properties

underlyingSchema wrap

Methods

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

Constructors

constructor

new TlvWrapper<O, T>(underlyingSchema, wrap, unwrap): TlvWrapper<O, T>
Type Parameters
- O
- T
Parameters
- underlyingSchema: TlvSchema<T>
- wrap: ((object: O) => T)
  - - (object): T
    - Parameters
      object: O
      Returns T
- unwrap: ((value: T) => O)
  - - (value): O
    - Parameters
      value: T
      Returns O
Returns TlvWrapper<O, T>
Overrides TlvSchema<O>.constructor
- Defined in packages/types/src/tlv/TlvWrapper.ts:11

Properties

`Protected` `Readonly`underlyingSchema

underlyingSchema: TlvSchema<T>

`Protected` `Readonly`wrap

wrap: ((object: O) => T)

Methods

decode

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

decodeInternal

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

decodeTlv

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

decodeTlvInternal

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

decodeTlvInternalValue

decodeTlvInternalValue(reader, typeLength): O
Parameters
- reader: TlvReader
- typeLength: TlvTypeLength
Returns O
Overrides TlvSchema.decodeTlvInternalValue
- Defined in packages/types/src/tlv/TlvWrapper.ts:19

encode

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

encodeInternal

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

encodeTlv

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

injectField

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

removeField

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