Class ListLoader<Command>

List loader exposes the API to register commands as classes

Example

const loader = new ListLoader([MyCommand, AnotherCommand])
const metadata = await loader.getMetaData()
const command = await loader.getCommand(metadata[0])

Type Parameters

Command extends AbstractBaseCommand

Implements

LoadersContract<Command>

Index

Constructors

constructor

Methods

getMetaData getCommand

Constructors

constructor

new ListLoader<Command extends AbstractBaseCommand>(
commands: Command[],
): ListLoader<Command>
Create a new list loader
Type Parameters
- Command extends AbstractBaseCommand
Parameters
- commands: Command[]
  Array of command classes to register
Returns ListLoader<Command>
- Defined in src/loaders/list_loader.ts:33

Methods

getMetaData

getMetaData(): Promise<CommandMetaData[]>
Returns an array of command metadata for all registered commands

Returns Promise<CommandMetaData[]>
Example
```
const metadata = await loader.getMetaData()
metadata.forEach(cmd => console.log(cmd.commandName))
```
Implementation of LoadersContract.getMetaData
- Defined in src/loaders/list_loader.ts:46

getCommand

getCommand(metaData: CommandMetaData): Promise<null | Command>
Returns the command class constructor for a given command. Null is returned when unable to lookup the command
Parameters
- metaData: CommandMetaData
  The command metadata to find
Returns Promise<null | Command>
Example
```
const command = await loader.getCommand(metadata)
if (command) {
  const instance = new command(kernel, parsed, ui, prompt)
}
```
Implementation of LoadersContract.getCommand
- Defined in src/loaders/list_loader.ts:64

Class ListLoader<Command>

Example

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ListLoader<Command>

Methods

getMetaData

Returns Promise<CommandMetaData[]>

Example

getCommand

Parameters

Returns Promise<null | Command>

Example

Settings

On This Page