Skip to main content
View as Markdown

Function: getDataProducts()

getDataProducts(directory): (options?) => Promise<DataProduct[]>

Defined in: data-products.ts:58

Returns all data products from EventCatalog.

You can optionally specify if you want to get the latest version of the data products.

Parameters

ParameterType
directorystring

Returns

Function

Parameters

ParameterType
options?{ latestOnly: boolean; }
options.latestOnly?boolean

Returns

Promise<DataProduct[]>

Example

import utils from '@eventcatalog/utils';

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

// Gets all data products (and versions) from the catalog
const dataProducts = await getDataProducts();

// Gets all data products (only latest version) from the catalog
const dataProducts = await getDataProducts({ latestOnly: true });