Class StructBuilder

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(
typeName: string,
topTT?: number,
): StructBuilder
Constructor.
Type Parameters
- U extends {}
Parameters
- typeName: string
 Type name, used in error messages.
- OptionaltopTT: number
 If specified, encode as complete TLV; otherwise, encode as TLV-VALUE only.
Returns StructBuilder
- Defined in pkg/tlv/src/struct-builder.ts:88

Properties

`Optional`subclass

subclass?: Constructor<U, []> & Decodable

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.

Methods

add

add<
 T,
 K extends string,
 Required extends boolean = false,
 Repeat extends boolean = false,
 FlagPrefix extends string = K,
 FlagBit extends string = never,
>(
 tt: 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",
 >,
 type: StructFieldType<T>,
 opts?: Options<Required, Repeat, FlagPrefix, FlagBit>,
): 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 pkg/tlv/src/struct-builder.ts:119

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 pkg/tlv/src/struct-builder.ts:171

setIsCritical

setIsCritical(cb: IsCritical): this
Change IsCritical on the EvDecoder.
Parameters
- cb: IsCritical
Returns this
- Defined in pkg/tlv/src/struct-builder.ts:162

`Static`evdOf

evdOf(
 sb: StructBuilder,
): {
 afterObservers: TlvObserver[];
 beforeObservers: TlvObserver[];
 applyDefaultsToRuleOptions(
 __namedParameters?: RuleOptions,
 ): Required<RuleOptions>;
 decode<R extends {} = U>(target: R, decoder: Decoder): R;
 decodeValue<R extends {} = U>(target: R, vd: Decoder): R;
 setIsCritical(cb: IsCritical): this;
 setUnknown(cb: UnknownElementHandler): this;
}
Access EvDecoder for certain customizations.
Type Parameters
- U extends {}
Parameters
- sb: StructBuilder
Returns {
 afterObservers: TlvObserver[];
 beforeObservers: TlvObserver[];
 applyDefaultsToRuleOptions(
 __namedParameters?: RuleOptions,
 ): Required<RuleOptions>;
 decode<R extends {} = U>(target: R, decoder: Decoder): R;
 decodeValue<R extends {} = U>(target: R, vd: Decoder): R;
 setIsCritical(cb: IsCritical): this;
 setUnknown(cb: UnknownElementHandler): this;
}
- ReadonlyafterObservers: TlvObserver[]
 Callbacks after decoding TLV-VALUE.
- ReadonlybeforeObservers: TlvObserver[]
 Callbacks before decoding TLV-VALUE.
- applyDefaultsToRuleOptions:function
 - applyDefaultsToRuleOptions(
 __namedParameters?: RuleOptions,
 ): Required<RuleOptions>
 - Parameters
 - __namedParameters: RuleOptions = {}
 Returns Required<RuleOptions>
 - Defined in pkg/tlv/src/ev-decoder.ts:47
- decode:function
 - decode<R extends {} = U>(target: R, decoder: Decoder): R
 - Decode TLV to target object.
 Type Parameters
 - R extends {} = U
 Parameters
 - target: R
 - decoder: Decoder
 Returns R
 - Defined in pkg/tlv/src/ev-decoder.ts:87
- decodeValue:function
 - decodeValue<R extends {} = U>(target: R, vd: Decoder): R
 - Decode TLV-VALUE to target object.
 Type Parameters
 - R extends {} = U
 Parameters
 - target: R
 - vd: Decoder
 Returns R
 - Defined in pkg/tlv/src/ev-decoder.ts:97
- setIsCritical:function
 - setIsCritical(cb: IsCritical): this
 - Set callback to determine whether TLV-TYPE is critical.
 Parameters
 - cb: IsCritical
 Returns this
 - Defined in pkg/tlv/src/ev-decoder.ts:75
- setUnknown:function
 - setUnknown(cb: UnknownElementHandler): this
 - Set callback to handle unknown elements.
 Parameters
 - cb: UnknownElementHandler
 Returns this
 - Defined in pkg/tlv/src/ev-decoder.ts:81
- Defined in pkg/tlv/src/struct-builder.ts:102

`Static`keysOf

keysOf(sb: StructBuilder): (keyof U)[]
Retrieve field names.
Type Parameters
- U extends {}
Parameters
- sb: StructBuilder
Returns (keyof U)[]
- Defined in pkg/tlv/src/struct-builder.ts:107

Class StructBuilder<U>

Remarks

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns StructBuilder<U>

Properties

Optionalsubclass

Optional ReadonlytopTT

ReadonlytypeName

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

StaticevdOf

Type Parameters

Parameters

ReadonlyafterObservers: TlvObserver<U>[]

ReadonlybeforeObservers: TlvObserver<U>[]

applyDefaultsToRuleOptions:function

Parameters

Returns Required<RuleOptions>

decode:function

Type Parameters

Parameters

Returns R

decodeValue:function

Type Parameters

Parameters

Returns R

setIsCritical:function

Parameters

Returns this

setUnknown:function

Parameters

Returns this

StatickeysOf

Type Parameters

Parameters

Returns (keyof U)[]

Settings

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,
>

`Static`evdOf

`Readonly`afterObservers: TlvObserver<U>[]

`Readonly`beforeObservers: TlvObserver<U>[]

`Static`keysOf