Class ValidEnum

Hierarchy (View Summary)

Enum
- ValidEnum

Index

Constructors

Properties

optional result default enums identifier symbol type

Methods

validate extract

Constructors

constructor

new ValidEnum(..._arguments: unknown[]): ValidEnum
Parameters
- ..._arguments: unknown[]
Returns ValidEnum
Inherited from Enum.constructor
- Defined in packages/core/src/commands/enums/enum.ts:21

Properties

optional

optional: boolean = true

Whether the enum value is optional.

result

result: unknown

`Static` `Readonly`default

default: Enum = ...

`Static` `Readonly`enums

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

`Static` `Readonly`identifier

identifier: string

`Static` `Readonly`symbol

symbol: number

`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
- _error: boolean = false
Returns boolean
Returns true if the enum value is applicable, or false otherwise.
Inherited from Enum.validate
- Defined in packages/core/src/commands/enums/enum.ts:31

`Static`extract

extract(_pointer: CommandArgumentPointer): null | Enum
Reads the next value from the pointer.
Parameters
- _pointer: CommandArgumentPointer
Returns null | Enum
Inherited from Enum.extract
- Defined in packages/core/src/commands/enums/enum.ts:43