Class OptionLayout<T, P>

Type parameters

T
P

Hierarchy

Layout<T | null, P>
- OptionLayout

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OptionLayout<T, P>(layout: Layout<T, "">, property?: P): OptionLayout<T, P>

Overrides Layout<T | null, P>.constructor
- Defined in src/marshmallow/index.ts:135
Type parameters
- T
- P
Parameters
- layout: Layout<T, "">
- Optional property: P
Returns OptionLayout<T, P>

Properties

discriminator

discriminator: Layout<number, "">

layout

layout: Layout<T, "">

Optional property

property?: P

span

span: number

Methods

decode

decode(b: Buffer, offset?: number): null | T

Overrides Layout.decode
- Defined in src/marshmallow/index.ts:150
Parameters
- b: Buffer
- offset: number = 0
Returns null | T

encode

encode(src: null | T, b: Buffer, offset?: number): number

Overrides Layout.encode
- Defined in src/marshmallow/index.ts:142
Parameters
- src: null | T
- b: Buffer
- offset: number = 0
Returns number

getSpan

getSpan(b: Buffer, offset?: number): number

Overrides Layout.getSpan
- Defined in src/marshmallow/index.ts:160
Parameters
- b: Buffer
- offset: number = 0
Returns number

replicate

replicate<AP>(name: AP): Layout<null | T, AP>

Inherited from Layout.replicate
- Defined in src/marshmallow/buffer-layout.ts:18
Type parameters
- AP: string
Parameters
- name: AP
Returns Layout<null | T, AP>