Class IntegerEnum

Hierarchy (View Summary)

ValidEnum
- IntegerEnum

Index

Constructors

Properties

optional result default enums identifier symbol type

Methods

validate extract

Constructors

constructor

new IntegerEnum(result: null | number): IntegerEnum
Parameters
- result: null | number
Returns IntegerEnum
Overrides ValidEnum.constructor
- Defined in packages/core/src/commands/enums/valid/integer.ts:21

Properties

optional

optional: boolean = true

Whether the enum value is optional.

`Readonly`result

result: null | number

The result of the enum.

`Static` `Readonly`default

default: Enum = ...

`Static` `Readonly`enums

enums: Map<string, Enum> = ...

`Static` `Readonly`identifier

identifier: "integer"

The type of the enum.

`Static` `Readonly`symbol

symbol: number = ...

The symbol of the enum.

`Static` `Readonly`type

type: 16 = 0x10

The type of the enum.

Methods

validate

validate(_error?: boolean): boolean
Checks if the enum value is applicable.
Parameters
- Optional_error: boolean
Returns boolean
Returns true if the enum value is applicable, or false otherwise.
Overrides ValidEnum.validate
- Defined in packages/core/src/commands/enums/valid/integer.ts:26

`Static`extract

extract(pointer: CommandArgumentPointer): null | IntegerEnum
Reads the next value from the pointer.
Parameters
- pointer: CommandArgumentPointer
  The pointer to read from.
Returns null | IntegerEnum
Overrides ValidEnum.extract
- Defined in packages/core/src/commands/enums/valid/integer.ts:41