@zuke/tsc-alias

← API reference

`@zuke/tsc-alias` — typed `tsc-alias` task wrappers for Zuke builds.

Symbols

# TscAliasRunSettings class
class TscAliasRunSettings extends ToolSettings

Settings for a tsc-alias run.

MemberSignatureDoc
project project(path: PathLike): this Path to the tsconfig.json to read aliases from (-p/--project).
watch watch(): this Re-run on file changes (--watch).
outDir outDir(path: PathLike): this Output directory of the compiled files to rewrite (--outDir).
declarationDir declarationDir(path: PathLike): this Output directory of the emitted declaration files (--declarationDir).
resolveFullPaths resolveFullPaths(): this Attempt to fully resolve alias paths, including extensions (--resolveFullPaths).
resolveFullExtension resolveFullExtension(ext: string): this Extension to append when resolving full paths, e.g. .js (--resolveFullExtension).
replacers replacers(...files: PathLike[]): this Additional replacer module file(s); repeatable (-f/--replacers).
dir dir(path: PathLike): this Base directory to resolve relative paths against (--dir).
fileExtensions fileExtensions(list: string): this Comma-separated list of file extensions to process (--fileExtensions).
verbose verbose(): this Print verbose output (--verbose).
debug debug(): this Print debug output (--debug).
silent silent(): this Suppress all output (--silent).
# TscAliasTasks const
const TscAliasTasks: TscAliasTasksApi

Typed task functions for the tsc-alias path-alias rewriter.

# TscAliasTasksApi interface
interface TscAliasTasksApi

The shape of TscAliasTasks.

MemberSignatureDoc
run run(configure?: Configure<TscAliasRunSettings>): Promise<CommandOutput> Rewrite TypeScript path aliases in compiled output with tsc-alias.