Class Enum

Hierarchy (View Summary)

Enum
- ValidEnum
- SoftEnum

Index

Constructors

Properties

optional result default enums identifier symbol type

Methods

validate extract

Constructors

constructor

new Enum(..._arguments: unknown[]): Enum
Parameters
- ..._arguments: unknown[]
Returns Enum
- 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: number

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.
- 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
- Defined in packages/core/src/commands/enums/enum.ts:43