Skip to content

API reference / @node-ts/bus-cli / GenerateMessageTypesOptions

Interface: GenerateMessageTypesOptions ​

Defined in: packages/bus-cli/src/generate-message-types/generate-message-types-options.ts:4

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

Properties ​

PropertyTypeDescriptionDefined in
cwd?stringThe directory relative paths and globs are resolved against Default process.cwd()packages/bus-cli/src/generate-message-types/generate-message-types-options.ts:35
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 projectpackages/bus-cli/src/generate-message-types/generate-message-types-options.ts:17
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
out?stringThe file to generate Default 'src/message-types.generated.ts'packages/bus-cli/src/generate-message-types/generate-message-types-options.ts:29
project?stringThe 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

Released under the MIT License.