JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2456387
  • Score
    100M100P100Q189547F
  • License MIT

Resole and parse `tsconfig.json`, replicating to TypeScript's behaviour

Package Exports

  • tsconfig
  • tsconfig/dist/tsconfig

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tsconfig) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

TSConfig

NPM version NPM downloads Build status Test coverage

Resolve and parse tsconfig.json, replicating TypeScript's behaviour.

Usage

See the TypeScript docs for information on setting up tsconfig.json.

API

  • resolve(cwd: string, path?: string): Promise<string | void> Resolve tsconfig.json, like TypeScript, allowing a path to be specified and falling back to recursively resolving tsconfig.json upward when no path is specified.
  • resolveSync(cwd: string, path?: string): string | void Synchronous resolve.
  • find(cwd: string): Promise<string | void> Standalone behaviour of recursively resolving tsconfig.json upward.
  • findSync(cwd: string): string | void Synchronous find.
  • load(cwd: string, path?: string): Promise<{ path?: string, config: any }> Resolve, load and parse tsconfig.json.
  • loadSync(cwd: string, path?: string): { path?: string, config: any } Synchronous load.
  • readFile(filename: string): Promise Read a JSON file as tsconfig.json (strip BOM, parse JSON and support empty contents).
  • readFileSync(filename: string): any Synchronous readFile.
  • parse(contents: string, filename: string): any Parse file contents as tsconfig.json (strip BOM, parse JSON and support empty contents).

Contributing

Feel free to open issues for discussion.

# Install dependencies/typings.
npm install

# Run test suite.
npm test

License

MIT License