Class TlvNumberSchema

Hierarchy (view full)

TlvNumericSchema<number>
- 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 TlvNumberSchema(type, lengthProvider, min?, max?): TlvNumberSchema
Parameters
- type: SignedInt | UnsignedInt | Float
- lengthProvider: ((value: number) => TlvLength)
  - - (value): TlvLength
    - Parameters
      value: number
      Returns TlvLength
- Optionalmin: number
- Optionalmax: number
Returns TlvNumberSchema
Overrides TlvNumericSchema<number>.constructor
- Defined in packages/types/src/tlv/TlvNumber.ts:90

Properties

`Protected` `Readonly`lengthProvider

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

`Protected` `Optional` `Readonly`max

max?: number

`Protected` `Optional` `Readonly`min

min?: number

`Protected` `Readonly`type

type: SignedInt | UnsignedInt | Float

Methods

bound

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

decode

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

decodeInternal

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

decodeTlv

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

decodeTlvInternal

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

decodeTlvInternalValue

decodeTlvInternalValue(reader, typeLength): number
Parameters
- reader: TlvReader
- typeLength: TlvTypeLength
Returns number
Overrides TlvNumericSchema.decodeTlvInternalValue
- Defined in packages/types/src/tlv/TlvNumber.ts:99

encode

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

encodeInternal

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

encodeTlv

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

encodeTlvInternal

encodeTlvInternal(writer, value, tag?): void
Parameters
- writer: TlvWriter
- value: number
- Optionaltag: TlvTag
Returns void
Inherited from TlvNumericSchema.encodeTlvInternal
- Defined in packages/types/src/tlv/TlvNumber.ts:48

injectField

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

removeField

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

validate

validate(value): void
Parameters
- value: number
Returns void
Overrides TlvNumericSchema.validate
- Defined in packages/types/src/tlv/TlvNumber.ts:108

validateBoundaries

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