Class FsLoader<Command>

Fs loader exposes the API to load commands from a directory. All files ending with ".js", ".cjs", ".mjs", ".ts" and ".mts" are considered as commands

Example

const loader = new FsLoader('./commands')
const metadata = await loader.getMetaData()
const command = await loader.getCommand(metadata[0])

Type Parameters

Command extends AbstractBaseCommand

Implements

LoadersContract<Command>

Index

Constructors

Methods

getMetaData getCommand

Constructors

constructor

new FsLoader<Command extends AbstractBaseCommand>(
comandsDirectory: string,
filter?: (filePath: string) => boolean,
): FsLoader<Command>
Create a new filesystem loader
Type Parameters
- Command extends AbstractBaseCommand
Parameters
- comandsDirectory: string
  Path to the directory containing command files
- Optionalfilter: (filePath: string) => boolean
  Optional filter function to exclude certain files
Returns FsLoader<Command>
- Defined in src/loaders/fs_loader.ts:55

Methods

getMetaData

getMetaData(): Promise<CommandMetaData[]>
Returns the metadata of all commands in the directory

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

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/fs_loader.ts:159