Copy as Markdown[View as Markdown](/docs/sdk/functions/dumpCatalog.md)

***

# Function: dumpCatalog()

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

Defined in: eventcatalog.ts:90

Dumps the catalog to a JSON file.

## Parameters[​](#parameters "Direct link to Parameters")

| Parameter   | Type     | Description                   |
| ----------- | -------- | ----------------------------- |
| `directory` | `string` | The directory of the catalog. |

## Returns[​](#returns "Direct link to Returns")

`Function`

A JSON file with the catalog.

### Parameters[​](#parameters-1 "Direct link to Parameters")

| Parameter                  | Type                              |
| -------------------------- | --------------------------------- |
| `options`?                 | { `includeMarkdown`: `boolean`; } |
| `options.includeMarkdown`? | `boolean`                         |

### Returns[​](#returns-1 "Direct link to Returns")

`Promise`<`EventCatalog`>