Class StructBuilder<U>

constructor

• new StructBuilder<U extends {}>(
      typeName: string,
      topTT?: number,
  ): StructBuilder<U>

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

Optionalsubclass

Optional ReadonlytopTT

ReadonlytypeName

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: If<
          IsNever<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: If<
        IsNever<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.

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

setIsCritical

• setIsCritical(cb: IsCritical): this

  Change IsCritical on the EvDecoder.

  Parameters

  • cb: IsCritical

  Returns this

StaticevdOf

• evdOf<U extends {}>(
      sb: StructBuilder<U>,
  ): {
      afterObservers: TlvObserver<U>[];
      beforeObservers: TlvObserver<U>[];
      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<U>): this;
  }

  Access EvDecoder for certain customizations.

  Type Parameters

  • U extends {}

  Parameters

  • sb: StructBuilder<U>

  Returns {
      afterObservers: TlvObserver<U>[];
      beforeObservers: TlvObserver<U>[];
      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<U>): this;
  }

  • ReadonlyafterObservers: TlvObserver<U>[]

    Callbacks after decoding TLV-VALUE.

  • ReadonlybeforeObservers: TlvObserver<U>[]

    Callbacks before decoding TLV-VALUE.

  • applyDefaultsToRuleOptions: function

    • applyDefaultsToRuleOptions(
          __namedParameters?: RuleOptions,
      ): Required<RuleOptions>

      Parameters

      • __namedParameters: RuleOptions = {}

      Returns Required<RuleOptions>

  • 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

  • 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

  • setIsCritical: function

    • setIsCritical(cb: IsCritical): this

      Set callback to determine whether TLV-TYPE is critical.

      Parameters

      • cb: IsCritical

      Returns this

  • setUnknown: function

    • setUnknown(cb: UnknownElementHandler<U>): this

      Set callback to handle unknown elements.

      Parameters

      • cb: UnknownElementHandler<U>

      Returns this

StatickeysOf

• keysOf<U extends {}>(sb: StructBuilder<U>): (keyof U)[]

  Retrieve field names.

  Type Parameters

  • U extends {}

  Parameters

  • sb: StructBuilder<U>

  Returns (keyof U)[]