Class FieldBuilder<T, Config>

Type Parameters

T extends Type = Type
Config extends FieldOptions = {}

Hierarchy

_ToArray<T, Config>
- FieldBuilder

FieldBuilder(length: number): FieldBuilder<ArrayType<T>, Config>
Parameters
- length: number
Returns FieldBuilder<ArrayType<T>, Config>
- Defined in src/fields.ts:48
- Defined in src/fields.ts:50

Index

Constructors

Methods

$type align bigEndian countedBy toInit

Constructors

constructor

new FieldBuilder<
    T extends Type<unknown> = Type<unknown>,
    Config extends FieldOptions = {},
>(
    type: T,
    init: Config,
): FieldBuilder<T, Config>
Type Parameters
- T extends Type<unknown> = Type<unknown>
- Config extends FieldOptions = {}
Parameters
- type: T
- init: Config
Returns FieldBuilder<T, Config>
Inherited from _ToArray<T, Config>.constructor
- Defined in src/fields.ts:51

Methods

$type

$type<NewValue>(): FieldBuilder<T & Type<NewValue>, Config>
Override the typescript type of the field's value, for example to override number with an enum type. This does not have any runtime effects.
Type Parameters
- NewValue
Returns FieldBuilder<T & Type<NewValue>, Config>
- Defined in src/fields.ts:89

align

align<const N extends number>(align: N): FieldBuilder<T, Config & { align: N }>
Align the field to a given byte boundary.
Type Parameters
- const N extends number
Parameters
- align: N
Returns FieldBuilder<T, Config & { align: N }>
- Defined in src/fields.ts:66

bigEndian

bigEndian(): FieldBuilder<T, Config & { bigEndian: true }>
Set the field to big-endian.

Returns FieldBuilder<T, Config & { bigEndian: true }>
- Defined in src/fields.ts:77

countedBy

countedBy<const K extends string>(
field: K,
): FieldBuilder<T, Config & { countedBy: K }>
Type Parameters
- const K extends string
Parameters
- field: K
Returns FieldBuilder<T, Config & { countedBy: K }>
- Defined in src/fields.ts:70

toInit

toInit(): FieldConfig<T> & Config
Returns FieldConfig<T> & Config
- Defined in src/fields.ts:81