Function: rmChannel()

rmChannel(directory): (path) => Promise<void>

Defined in: channels.ts:137

Delete a channel at it's given path.

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
path	string

Returns

Promise<void>

Example

import utils from '@eventcatalog/utils';

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

// removes a channel at the given path (channels dir is appended to the given path)
// Removes the channel at channels/InventoryChannel
await rmChannel('/InventoryChannel');