Function: getCommand()

getCommand(directory): (id, version?, options?) => Promise<Command>

Defined in: commands.ts:38

Returns a command from EventCatalog.

You can optionally specify a version to get a specific version of the command

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
id	string
version?	string
options?	{ attachSchema: boolean; }
options.attachSchema?	boolean

Returns

Promise<Command>

Example

import utils from '@eventcatalog/utils';

const { getCommand } = utils('/path/to/eventcatalog');

// Gets the latest version of the command
const command = await getCommand('UpdateInventory');

// Gets a version of the command
const command = await getCommand('UpdateInventory', '0.0.1');

// Gets the command with the schema attached
const command = await getCommand('UpdateInventory', '0.0.1', { attachSchema: true });