Expand description
Project References Support
This module implements TypeScript project references, which enable:
- Splitting large codebases into smaller projects
- Faster incremental builds through project-level caching
- Better editor support with scoped type checking
- Cleaner dependency management between project boundaries
§Key Concepts
- Composite Project: A project with
composite: truethat can be referenced - Project Reference: A
{ path: string, prepend?: boolean }entry in tsconfig.json - Build Order: Topologically sorted order of projects based on dependencies
- Declaration Output: .d.ts files that reference consuming projects use
Structs§
- Composite
Compiler Options - Extended
CompilerOptionswith composite project settings - Project
Reference - A project reference as specified in tsconfig.json
- Project
Reference Graph - Graph of project references for build ordering
- Resolved
Project - A resolved project with its configuration and metadata
- Resolved
Project Reference - A resolved reference to another project
- TsConfig
With References - Extended
TsConfigthat includes project references
Functions§
- get_
declaration_ output_ path - Get the declaration output path for a source file in a composite project
- load_
project - Load a project from its tsconfig.json path
- parse_
tsconfig_ with_ references - Parse tsconfig with references support
- resolve_
cross_ project_ import - Resolve an import from a referencing project to a referenced project’s declarations
- validate_
composite_ project - Validate that a project meets composite requirements
Type Aliases§
- Project
Id - Unique identifier for a project in the reference graph