Skip to main content

addFileToQuery

Callable

  • addFileToQuery(directory: string): (id: string, file: { content: string; fileName: string }, version?: string) => Promise<void>

  • Add a file to a query by it's id.

    Optionally specify a version to add a file to a specific version of the query.

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

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

    // adds a file to the latest GetOrder query
    await addFileToQuery('GetOrder', { content: 'Hello world', fileName: 'hello.txt' });

    // adds a file to a specific version of the GetOrder query
    await addFileToQuery('GetOrder', { content: 'Hello world', fileName: 'hello.txt' }, '0.0.1');