@rollup/plugin-typescript

index signature

[option: string]: CompilerOptionsValue | TsConfigSourceFile | undefined | any;

property type

type: 'program';

method factory

factory: (
    program: Program,
    getProgram?: () => Program
) => StagedTransformerFactory<T>;

• Factory receives the current Program and may also receive a getter for retrieving the Program at call time. The getter may be provided in all modes. In non-watch it returns the same Program as the first argument. In watch mode: - When recreateTransformersOnRebuild is enabled (plugin option), the getter reflects the latest Program across rebuilds. - When disabled (default, legacy behavior), factories are reused and the getter refers to the initial Program from when the factory was created. The second parameter remains optional for backwards compatibility with existing transformer factories.

property cacheDir

cacheDir?: string;

• If using incremental this is the folder where the cached files will be created and kept for Typescript incremental compilation.

property compilerOptions

compilerOptions?: PartialCompilerOptions;

• Pass additional compiler options to the plugin.

property exclude

exclude?: FilterPattern;

• Determine which files are ignored by Typescript

property filterRoot

filterRoot?: string | false;

• Sets the resolve value for the underlying filter function. If not set will use the rootDir property

  See Also

  • https://github.com/rollup/plugins/tree/master/packages/pluginutils#createfilter @rollup/pluginutils createFilter

property include

include?: FilterPattern;

• Determine which files are transpiled by Typescript (all .ts and .tsx files by default).

property noForceEmit

noForceEmit?: boolean;

• Override force setting of noEmit and emitDeclarationOnly and use what is defined in tsconfig.json

property outputToFilesystem

outputToFilesystem?: boolean;

• When set to false, force non-cached files to always be emitted in the output directory.output If not set, will default to true with a warning.

property recreateTransformersOnRebuild

recreateTransformersOnRebuild?: boolean;

• Advanced: when true, recreate custom transformer factories on each TypeScript watch rebuild so that program/typeChecker-based factories are rebuilt and getProgram() (when used) reflects the latest Program across rebuilds. Defaults to false (legacy behavior), which reuses factories for the lifetime of the watch session.

property transformers

transformers?:
    | CustomTransformerFactories
    | ((program: Program) => CustomTransformers);

• TypeScript custom transformers

property tsconfig

tsconfig?: string | false;

• When set to false, ignores any options specified in the config file. If set to a string that corresponds to a file path, the specified file will be used as config file.

property tslib

tslib?: Promise<string> | string;

• Overrides the injected TypeScript helpers with a custom version.

property typescript

typescript?: typeof _typescript;

• Overrides TypeScript used for transpilation

property type

type: 'typeChecker';

method factory

factory: (typeChecker: TypeChecker) => StagedTransformerFactory<T>;