Class CommandSpec

A command the adapter declares; maps to CommandRegister.

Example

new CommandSpec("status", "Show the run status").toRegister().name; // "status"

Index

Constructors

constructor

new CommandSpec(
    name: string,
    description: string,
    options?: CommandSpecOptions,
): CommandSpec
Declares a command.
Parameters
- name: string
  The command name.
- description: string
  At most command.description_max_chars characters.
- options: CommandSpecOptions = {}
  Options, scope, required level and the control flag.
Returns CommandSpec

Properties

`Readonly`control

control: boolean

Whether it is a control command.

`Readonly`description

description: string

At most command.description_max_chars characters.

`Readonly`name

name: string

The command name.

`Readonly`options

options: readonly {}[]

The options.

`Readonly`requiredLevel

requiredLevel: string | undefined

The required level, if not the default.

`Readonly`scopeId

scopeId: string | undefined

The scope target, if any.

`Readonly`scopeKind

scopeKind: string | undefined

Where it applies, if not the server default.

Methods

toRegister

toRegister(settings?: SdkSettings): {}
Builds the generated CommandRegister.
Parameters
- settings: SdkSettings = DEFAULTS
  The limit command.description_max_chars (default DEFAULTS).
Returns {}
The registration body.

Throws
RangeError when the description is longer than the limit or the scope kind or the level is outside its vocabulary.

Class CommandSpec

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CommandSpec

Properties

Readonlycontrol

Readonlydescription

Readonlyname

Readonlyoptions

ReadonlyrequiredLevel

ReadonlyscopeId

ReadonlyscopeKind

Methods

toRegister

Parameters

Returns {}

Throws

Settings

On This Page

`Readonly`control

`Readonly`description

`Readonly`name

`Readonly`options

`Readonly`requiredLevel

`Readonly`scopeId

`Readonly`scopeKind