Class AnySchema

Hierarchy (view full)

TlvSchema<TlvStream>
- AnySchema

Index

Constructors

Methods

decode decodeAnyTlvStream decodeGenericArrayOrList decodeGenericElement decodeGenericStructure decodeInternal decodeTlv decodeTlvInternal decodeTlvInternalValue decodeTlvValueRec encode encodeInternal encodeTlv encodeTlvInternal getEncodedByteLength injectField removeField validate

Constructors

constructor

new AnySchema(): AnySchema
Returns AnySchema
Inherited from TlvSchema<TlvStream>.constructor

Methods

decode

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

decodeAnyTlvStream

decodeAnyTlvStream(encoded): any
Parameters
- encoded: TlvStream
Returns any
- Defined in packages/types/src/tlv/TlvAny.ts:115

decodeGenericArrayOrList

decodeGenericArrayOrList(reader, allowTag?): any[]
Parameters
- reader: TlvArrayReader
- allowTag: boolean = false
Returns any[]
- Defined in packages/types/src/tlv/TlvAny.ts:157

decodeGenericElement

decodeGenericElement(reader, preReadElement?, allowTag?): any
Parameters
- reader: TlvArrayReader
- OptionalpreReadElement: TlvElement<any>
- allowTag: boolean = false
Returns any
- Defined in packages/types/src/tlv/TlvAny.ts:128

decodeGenericStructure

decodeGenericStructure(reader): {
[key: string]: any;
}
Parameters
- reader: TlvArrayReader
Returns {
[key: string]: any;
}
- [key: string]: any
- Defined in packages/types/src/tlv/TlvAny.ts:174

decodeInternal

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

decodeTlv

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

decodeTlvInternal

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

decodeTlvInternalValue

decodeTlvInternalValue(reader, typeLength): TlvStream
Parameters
- reader: TlvReader
- typeLength: TlvTypeLength
Returns TlvStream
Overrides TlvSchema.decodeTlvInternalValue
- Defined in packages/types/src/tlv/TlvAny.ts:66

decodeTlvValueRec

decodeTlvValueRec(reader, typeLength, tlvStream, tag?): TlvStream
Parameters
- reader: TlvReader
- typeLength: TlvTypeLength
- tlvStream: TlvStream
- Optionaltag: TlvTag
Returns TlvStream
- Defined in packages/types/src/tlv/TlvAny.ts:70

encode

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

encodeInternal

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

encodeTlv

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

encodeTlvInternal

encodeTlvInternal(writer, tlvStream, tagAssigned?): void
Parameters
- writer: TlvWriter
- tlvStream: TlvStream
- OptionaltagAssigned: TlvTag
Returns void
Overrides TlvSchema.encodeTlvInternal
- Defined in packages/types/src/tlv/TlvAny.ts:38

getEncodedByteLength

getEncodedByteLength(tlvStream): number
Parameters
- tlvStream: TlvStream
Returns number
- Defined in packages/types/src/tlv/TlvAny.ts:13

injectField

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

removeField

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

validate

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