---
url: >-
  https://node-ts.github.io/bus/api/bus-cli/interfaces/GenerateMessageTypesOptions.md
---
[API reference](../../index.md) / [@node-ts/bus-cli](../index.md) / GenerateMessageTypesOptions

# Interface: GenerateMessageTypesOptions

Defined in: [packages/bus-cli/src/generate-message-types/generate-message-types-options.ts:4](https://github.com/node-ts/bus/blob/2e6cf65c27833b707ae31ee623cfb6343770f434/packages/bus-cli/src/generate-message-types/generate-message-types-options.ts#L4)

Options for generating message types. Relative paths and globs are resolved against `cwd`.

## Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="property-cwd"></a> `cwd?` | `string` | The directory relative paths and globs are resolved against **Default** `process.cwd()` | [packages/bus-cli/src/generate-message-types/generate-message-types-options.ts:35](https://github.com/node-ts/bus/blob/2e6cf65c27833b707ae31ee623cfb6343770f434/packages/bus-cli/src/generate-message-types/generate-message-types-options.ts#L35) |
| <a id="property-entry"></a> `entry?` | `string`\[] | Globs of the files to read messages and workflow state from. Every exported, non-abstract class with a `$name` in these files is included. Files the tsconfig doesn't include, such as test fixtures, are read too. **Default** `every file in the project` | [packages/bus-cli/src/generate-message-types/generate-message-types-options.ts:17](https://github.com/node-ts/bus/blob/2e6cf65c27833b707ae31ee623cfb6343770f434/packages/bus-cli/src/generate-message-types/generate-message-types-options.ts#L17) |
| <a id="property-exclude"></a> `exclude?` | `string`\[] | Globs of files to leave out, even if they match `entry` **Default** `[]` | [packages/bus-cli/src/generate-message-types/generate-message-types-options.ts:23](https://github.com/node-ts/bus/blob/2e6cf65c27833b707ae31ee623cfb6343770f434/packages/bus-cli/src/generate-message-types/generate-message-types-options.ts#L23) |
| <a id="property-out"></a> `out?` | `string` | The file to generate **Default** `'src/message-types.generated.ts'` | [packages/bus-cli/src/generate-message-types/generate-message-types-options.ts:29](https://github.com/node-ts/bus/blob/2e6cf65c27833b707ae31ee623cfb6343770f434/packages/bus-cli/src/generate-message-types/generate-message-types-options.ts#L29) |
| <a id="property-project"></a> `project?` | `string` | The tsconfig.json of the project that declares the messages **Default** `'tsconfig.json'` | [packages/bus-cli/src/generate-message-types/generate-message-types-options.ts:9](https://github.com/node-ts/bus/blob/2e6cf65c27833b707ae31ee623cfb6343770f434/packages/bus-cli/src/generate-message-types/generate-message-types-options.ts#L9) |