Function: addDataStoreToService()

addDataStoreToService(directory): (id, operation, dataStore, version?) => Promise<void>

Defined in: services.ts:571

Add a data store to a service by it's id.

Optionally specify a version to add the data store to a specific version of the service.

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
id	string
operation	"writesTo" | "readsFrom"
dataStore	{ id: string; version: string; }
dataStore.id	string
dataStore.version?	string
version?	string

Returns

Promise<void>

Example

import utils from '@eventcatalog/utils';

// Adds an data store to the service
const { addDataStoreToService } = utils('/path/to/eventcatalog');

// Adds a new data store (orders-db) that the InventoryService will write to
await addDataStoreToService('InventoryService', 'writesTo', { id: 'orders-db', version: '2.0.0' });

* // Adds a new data store (OrderComplete) that the InventoryService will read from
await addDataStoreToService('InventoryService', 'readsFrom', { id: 'orders-db', version: '1.0.0' });