Skip to main content

versionChannel

Callable

  • versionChannel(directory: string): (id: string) => Promise<void>

  • Version a channel by it's id.

    Takes the latest channel and moves it to a versioned directory.

    @example
    import utils from '@eventcatalog/utils';

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

    // moves the latest inventory.{env}.events channel to a versioned directory
    // the version within that channel is used as the version number.
    await versionChannel('inventory.{env}.events');