Skip to main content

addFileToDomain

Callable

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

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

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

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

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

    // adds a file to the latest Payment event
    await addFileToDomain('Payment', { content: 'Hello world', fileName: 'hello.txt' });

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