Class Boolean

Represent a single bit within a BitStructure as a JavaScript boolean.

NOTE User code should not invoke this constructor directly. Use the container {@link BitStructure#addBoolean|addBoolean} helper method.

param container: initializer for {@link BitField#container|container}.
param [property]: initializer for {@link Layout#property|property}.

Hierarchy

BitField
- Boolean

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Boolean(container: BitStructure, property: string): Boolean

Overrides BitField.constructor
- Defined in Layout.ts:2202
Parameters
- container: BitStructure
- property: string
Returns Boolean

Properties

bits

bits: number

container

container: BitStructure

property

property: string

start

start: number

valueMask

valueMask: number

wordMask

wordMask: number

Methods

decode

decode(b?: Uint8Array, offset?: number): boolean

Overrides BitField.decode
- Defined in Layout.ts:2209
Override {@link BitField#decode|decode} for Boolean.

Parameters
- Optional b: Uint8Array
- Optional offset: number
Returns boolean

encode

encode(value: number | boolean): void

Overrides BitField.encode
- Defined in Layout.ts:2214
override
Parameters
- value: number | boolean
Returns void

Generated using TypeDoc