![](\".github/logo.webp\"){kind=logo}
\n\n\t\n
\n\t![](\"https://raw.githubusercontent.com/privatenumber/sponsors/master/banners/assets/donate.webp\")
\n\t![](\"https://raw.githubusercontent.com/privatenumber/sponsors/master/banners/assets/sponsor.webp\")
\n
Already a sponsor? Join the discussion in the Development repo!
\n\n## Install\n\n```bash\nnpm install get-tsconfig\n```\n\n## Why?\nFor TypeScript related tooling to correctly parse `tsconfig.json` file without depending on TypeScript.\n\n## API\n\n### getTsconfig(searchPath?, configName?, cache?, includes?)\n\nSearches for a tsconfig file (defaults to `tsconfig.json`) in the `searchPath` and parses it. (If you already know the tsconfig path, use [`parseTsconfig`](#parsetsconfigtsconfigpath-cache) instead). Returns `null` if a config file cannot be found, or an object containing the path and parsed TSConfig object if found.\n\nReturns:\n\n```ts\ntype TsconfigResult = {\n\n /**\n * The path to the tsconfig.json file\n */\n path: string\n\n /**\n * The resolved tsconfig.json file\n */\n config: TsConfigJsonResolved\n}\n```\n\n#### searchPath\nType: `string`\n\nDefault: `process.cwd()`\n\nPath to a source file or directory. The directory tree is searched up for a `tsconfig.json` file. Typically a TypeScript/JavaScript file path (e.g. `./src/index.ts`), but a directory path also works if you don't have a specific file.\n\n#### configName\nType: `string`\n\nDefault: `tsconfig.json`\n\nThe file name of the TypeScript config file.\n\n#### cache\nType: `Map\n\t\n\t\t![](\"https://cdn.jsdelivr.net/gh/privatenumber/sponsors/sponsorkit/sponsors.svg\")
\n\t\n