Function: writeDataProductToDomain()

writeDataProductToDomain(directory): (dataProduct, domain, options) => Promise<void>

Defined in: data-products.ts:147

Write a data product to a domain in EventCatalog.

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
dataProduct	DataProduct
domain	{ id: string; version: string; }
domain.id	string
domain.version?	string
options	{ format: "md" | "mdx"; override: boolean; path: string; }
options.format?	"md" | "mdx"
options.override?	boolean
options.path?	string

Returns

Promise<void>

Example

import utils from '@eventcatalog/utils';

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

// Write a data product to a domain
// Data product would be written to domains/Shopping/data-products/CustomerDataProduct
await writeDataProductToDomain({
  id: 'CustomerDataProduct',
  name: 'Customer Data Product',
  version: '0.0.1',
  summary: 'Customer data product',
  markdown: '# Customer data product',
}, { id: 'Shopping' });