Logo for jsDocs.io

tsconfig

  • Version 7.0.0
  • Published
  • 4 dependencies
  • MIT license

Install

npm i tsconfig
yarn add tsconfig
pnpm add tsconfig

Overview

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

Index

Functions

Interfaces

Functions

function find

find: (dir: string) => Promise<string | void>;

    function findSync

    findSync: (dir: string) => string | void;

      function load

      load: (cwd: string, filename?: string) => Promise<LoadResult>;

        function loadSync

        loadSync: (cwd: string, filename?: string) => LoadResult;

          function parse

          parse: (contents: string, filename: string) => any;

            function readFile

            readFile: (filename: string) => Promise<any>;

              function readFileSync

              readFileSync: (filename: string) => any;

                function resolve

                resolve: (cwd: string, filename?: string) => Promise<string | void>;

                  function resolveSync

                  resolveSync: (cwd: string, filename?: string) => string | void;

                    Interfaces

                    interface LoadResult

                    interface LoadResult {}

                      property config

                      config: any;

                        property path

                        path?: string;

                          Package Files (1)

                          Dependencies (4)

                          Dev Dependencies (10)

                          Peer Dependencies (0)

                          No peer dependencies.

                          Badge

                          To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                          You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/tsconfig.

                          • Markdown
                            [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/tsconfig)
                          • HTML
                            <a href="https://www.jsdocs.io/package/tsconfig"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>