Function: addFileToQuery()

addFileToQuery(directory): (id, file, version?, options?) => Promise<void>

Defined in: queries.ts:253

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.

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
id	string
file	{ content: string; fileName: string; }
file.content	string
file.fileName?	string
version?	string
options?	{ path: string; }
options.path?	string

Returns

Promise<void>

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');