Function: getChannel()

getChannel(directory): (id, version?) => Promise<Channel>

Defined in: channels.ts:29

Returns a channel from EventCatalog.

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

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
id	string
version?	string

Returns

Promise<Channel>

Example

import utils from '@eventcatalog/utils';

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

// Gets the latest version of the channel
const channel = await getChannel('InventoryChannel');

// Gets a version of the channel
const channel = await getChannel('InventoryChannel', '0.0.1');