Class StructBuilder<U>

Helper to build a base class that represents a TLV structure.

Remarks

StructBuilder allows you to define the typing, constructor, encoder, and decoder, while writing each field only once. To be compatible with StructBuilder, the TLV structure being described shall contain a sequence of sub-TLV elements with distinct TLV-TYPE numbers, where each sub-TLV-TYPE appears zero, one, or multiple times.

To use StructBuilder, calling code should follow these steps:

Invoke .add() method successively to define sub-TLV elements.
Obtain a base class via .baseClass() method, which contains one field for each sub-TLV-TYPE as defined, along with constructor, encoding, and decoding functions.
Declare a subclass deriving from this base class, to add more functionality.
Assign the subclass constructor to .subclass property of the builder.

Type Parameters

U extends {}

Index

Constructors

constructor

new StructBuilder<U>(typeName, topTT?): StructBuilder<U>
Constructor.
Type Parameters
- U extends {}
Parameters
- typeName: string
  Type name, used in error messages.
- Optional topTT: number
  If specified, encode as complete TLV; otherwise, encode as TLV-VALUE only.
Returns StructBuilder<U>
- Defined in struct-builder.ts:88

Properties

`Optional` subclass

subclass?: Constructor<U, []>

Subclass constructor. This must be assigned, otherwise decoding function will not work.

`Optional` `Readonly` topTT

topTT?: number

If specified, encode as complete TLV; otherwise, encode as TLV-VALUE only.

`Readonly` typeName

typeName: string

Type name, used in error messages.

Accessors

keys

get keys(): string[]
Return field names.

Returns string[]
- Defined in struct-builder.ts:102

Methods

add

add<T, K, Required, Repeat, FlagPrefix, FlagBit>(tt, key, type, opts?): StructBuilder<{
[KeyType in string | number | symbol]: (U & AddField<K, T, Required, Repeat> & AddFlags<FlagPrefix, FlagBit>)[KeyType]
}>
Add a field.
Type Parameters
- T
- K extends string
- Required extends boolean = false
- Repeat extends boolean = false
- FlagPrefix extends string = K
- FlagBit extends string = never
Parameters
- tt: number
  TLV-TYPE number.
- key: IfNever<FlagBit, K, Repeat extends true
      ? "ERROR: can only define flags on a non-repeatable number field"
      : T extends number
          ? K
          : "ERROR: can only define flags on a non-repeatable number field">
  Field name on the base class.
- type: StructFieldType<T>
  Field type.
- opts: Options<Required, Repeat, FlagPrefix, FlagBit> = {}
  Field options.
Returns StructBuilder<{
[KeyType in string | number | symbol]: (U & AddField<K, T, Required, Repeat> & AddFlags<FlagPrefix, FlagBit>)[KeyType]
}>
StructBuilder annotated with field typing.
- Defined in struct-builder.ts:114

baseClass

baseClass<S>(): (new () => {
[KeyType in string | number | symbol]: U[KeyType]
} & EncodableObj) & Decodable<S>
Obtain a base class for the TLV structure class.
Type Parameters
- S
  Subclass type.
Returns (new () => {
[KeyType in string | number | symbol]: U[KeyType]
} & EncodableObj) & Decodable<S>
- Defined in struct-builder.ts:166

setIsCritical

setIsCritical(cb): this
Change IsCritical on the EvDecoder.
Parameters
- cb: IsCritical
Returns this
- Defined in struct-builder.ts:157

Class StructBuilder<U>

Remarks

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns StructBuilder<U>

Properties

`Optional` subclass

`Optional` `Readonly` topTT

`Readonly` typeName

Accessors

keys

Returns string[]

Methods

add

Type Parameters

Parameters

Returns StructBuilder<{
[KeyType in string | number | symbol]: (U & AddField<K, T, Required, Repeat> & AddFlags<FlagPrefix, FlagBit>)[KeyType]
}>

baseClass

Type Parameters

Returns (new () => {
[KeyType in string | number | symbol]: U[KeyType]
} & EncodableObj) & Decodable<S>

setIsCritical

Parameters

Returns this

Settings

Member Visibility

Theme

On This Page

Class StructBuilder<U>

Remarks

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns StructBuilder<U>

Properties

Optional subclass

Optional Readonly topTT

Readonly typeName

Accessors

keys

Returns string[]

Methods

add

Type Parameters

Parameters

Returns StructBuilder<{ [KeyType in string | number | symbol]: (U & AddField<K, T, Required, Repeat> & AddFlags<FlagPrefix, FlagBit>)[KeyType]}>

baseClass

Type Parameters

Returns (new () => { [KeyType in string | number | symbol]: U[KeyType]} & EncodableObj) & Decodable<S>

setIsCritical

Parameters

Returns this

Settings

Member Visibility

Theme

On This Page

`Optional` subclass

`Optional` `Readonly` topTT

`Readonly` typeName

Returns StructBuilder<{
[KeyType in string | number | symbol]: (U & AddField<K, T, Required, Repeat> & AddFlags<FlagPrefix, FlagBit>)[KeyType]
}>

Returns (new () => {
[KeyType in string | number | symbol]: U[KeyType]
} & EncodableObj) & Decodable<S>