GenerateOutputOptions

GenerateOutputOptions = object

Defined in: core/generate/index.ts:11

Options for controlling the generated output files.

Properties

actor?

optional actor: { disabled: true; } | { disabled?: false; interfaceFile?: boolean; }

Defined in: core/generate/index.ts:21

Options for controlling the generated actor files.

Type Declaration

{ disabled: true; }

disabled

disabled: true

If true, skips generating the actor file (<service-name>.ts).

Default

false

{ disabled?: false; interfaceFile?: boolean; }

disabled?

optional disabled: false

interfaceFile?

optional interfaceFile: boolean

If true, generates a <service-name>.d.ts file that contains the same types of the <service-name>.ts file. Useful to add to LLMs’ contexts’ to give knowledge about what types are available in the service.

Has no effect if disabled is true.

Default

false

---

declarations?

optional declarations: object

Defined in: core/generate/index.ts:45

Options for controlling the generated declarations files.

flat?

optional flat: boolean

If true, generates declaration files directly in outDir instead of in a declarations/ subfolder.

This is useful for projects that need full control over the output file layout without post-processing scripts to move or rename the generated files.

Default

false

rootExports?

optional rootExports: boolean

If true, exports root types in the declarations file.

Default

false

typescript?

optional typescript: boolean

If true, generates a single declarations/<service-name>.did.ts TypeScript file instead of separate declarations/<service-name>.did.js and declarations/<service-name>.did.d.ts files.

This eliminates the need for allowJs: true in the consumer’s TypeScript configuration.

Default

false

---

force?

optional force: boolean

Defined in: core/generate/index.ts:17

If true, overwrite existing files. If false, abort on collisions.

Default

false