Launch Week Day 1: Socket for Jira Is Now Available.Learn More
Socket
Book a DemoSign in
Socket

tsconfig

Package Overview
Dependencies
Maintainers
2
Versions
24
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

tsconfig

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

latest
Source
npmnpm
Version
7.0.0
Version published
Weekly downloads
3.1M
1.85%
Maintainers
2
Weekly downloads
 
Created
Source

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

Keywords

TypeScript

FAQs

Package last updated on 28 Aug 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts