peach a19a732be8 commit message 2 years ago
..
dist a19a732be8 commit message 2 years ago
node_modules a19a732be8 commit message 2 years ago
LICENSE a19a732be8 commit message 2 years ago
README.md a19a732be8 commit message 2 years ago
package.json a19a732be8 commit message 2 years ago

README.md

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 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 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