API reference › @evolu/nodejs › TestJSDoc › TestJSDocExamplesOptions

Defined in: packages/nodejs/src/TestJSDoc.ts:31

Options for linting, compiling, and executing TypeScript documentation examples.

Properties

aliases?

readonly optional aliases?: Readonly<Record<string, string>>;

Defined in: packages/nodejs/src/TestJSDoc.ts:35

Package imports redirected to absolute TypeScript entry paths.

cwd?

readonly optional cwd?: string;

Defined in: packages/nodejs/src/TestJSDoc.ts:37

Directory used for globbing and package resolution.

include

readonly include: string | readonly string[];

Defined in: packages/nodejs/src/TestJSDoc.ts:33

Source files or glob patterns resolved from cwd.

typescriptPackage?

readonly optional typescriptPackage?: string;

Defined in: packages/nodejs/src/TestJSDoc.ts:39

TypeScript compiler package. Defaults to "typescript".