Skip to main content

getEntity

Callable

  • getEntity(directory: string): (id: string, version?: string) => Promise<Entity>

  • Returns an entity from EventCatalog.

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

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

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

    // Gets the latest version of the entity
    const entity = await getEntity('User');

    // Gets a version of the entity
    const entity = await getEntity('User', '0.0.1');