Skip to main content

Function: dumpCatalog()

dumpCatalog(directory): (options?) => Promise<EventCatalog>

Defined in: eventcatalog.ts:90

Dumps the catalog to a JSON file.

Parameters

ParameterTypeDescription
directorystringThe directory of the catalog.

Returns

Function

A JSON file with the catalog.

Parameters

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

Returns

Promise<EventCatalog>