https://github.com/flex-development/tsconfig-types
TypeScript definitions for tsconfig.json
https://github.com/flex-development/tsconfig-types
tsconfig tsconfig-json typescript typescript-definitions
Last synced: 2 months ago
JSON representation
TypeScript definitions for tsconfig.json
- Host: GitHub
- URL: https://github.com/flex-development/tsconfig-types
- Owner: flex-development
- License: bsd-3-clause
- Created: 2022-11-27T08:36:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-25T01:59:30.000Z (4 months ago)
- Last Synced: 2025-03-28T08:35:37.999Z (3 months ago)
- Topics: tsconfig, tsconfig-json, typescript, typescript-definitions
- Language: TypeScript
- Homepage: https://github.com/flex-development/tsconfig-types
- Size: 5.9 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/funding.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# tsconfig-types
[](https://github.com/flex-development/tsconfig-types/releases/latest)
[](https://npmjs.com/package/@flex-development/tsconfig-types)
[](https://github.com/voxpelli/badges-cjs-esm)
[](LICENSE.md)
[](https://conventionalcommits.org)
[](https://typescriptlang.org)
[](https://vitest.dev)
[](https://yarnpkg.com)
[TypeScript][] definitions for `tsconfig.json`
## Contents
- [What is this?](#what-is-this)
- [Install](#install)
- [Use](#use)
- [API](#api)
- [Related](#related)
- [Contribute](#contribute)
## What is this?
This package contains TypeScript definitions for `tsconfig.json` files and values used in `tsconfig.json` files.
## Install
In Node.js with [yarn][]:
```sh
yarn add @flex-development/tsconfig-types
```
See Git - Protocols | Yarn
for details regarding installing from Git.
## Use
```ts
import type {
CompilerOptions,
Module,
ModuleDetection,
ModuleResolution,
Paths,
Target,
Tsconfig
} from '@flex-development/tsconfig-types'
```
## API
- [`BuildOptions`](./src/build-options.mts)
- [`CompilerOption`](./src/compiler-option.mts)
- [`CompilerOptionsValue`](./src/compiler-options-value.mts)
- [`CompilerOptions`](./src/compiler-options.mts)
- [`FallbackPollingMap`](./src/fallback-polling-map.mts)
- [`FallbackPolling`](./src/fallback-polling.mts)
- [`ImportsNotUsedAsValuesMap`](./src/imports-not-used-as-values-map.mts)
- [`ImportsNotUsedAsValues`](./src/imports-not-used-as-values.mts)
- [`JsonArray`](./src/json-array.mts)
- [`JsonObject`](./src/json-object.mts)
- [`JsonPrimitive`](./src/json-primitive.mts)
- [`JsonValue`](./src/json-value.mts)
- [`JsxEmitMap`](./src/jsx-emit-map.mts)
- [`JsxEmit`](./src/jsx-emit.mts)
- [`JsxFactoryMap`](./src/jsx-factory-map.mts)
- [`JsxFactory`](./src/jsx-factory.mts)
- [`JsxFragmentFactoryMap`](./src/jsx-fragment-factory-map.mts)
- [`JsxFragmentFactory`](./src/jsx-fragment-factory.mts)
- [`JsxImportSourceMap`](./src/jsx-import-source-map.mts)
- [`JsxImportSource`](./src/jsx-import-source.mts)
- [`LibFile`](./src/lib-file.mts)
- [`LibMap`](./src/lib-map.mts)
- [`Lib`](./src/lib.mts)
- [`MapLike`](./src/map-like.mts)
- [`ModuleDetectionMap`](./src/module-detection-map.mts)
- [`ModuleDetection`](./src/module-detection.mts)
- [`ModuleMap`](./src/module-map.mts)
- [`ModuleResolutionMap`](./src/module-resolution-map.mts)
- [`ModuleResolution`](./src/module-resolution.mts)
- [`Module`](./src/module.mts)
- [`NewLineMap`](./src/new-line-map.mts)
- [`NewLine`](./src/new-line.mts)
- [`Paths`](./src/paths.mts)
- [`Plugin`](./src/plugin.mts)
- [`PollingWatchMap`](./src/polling-watch-map.mts)
- [`PollingWatch`](./src/polling-watch.mts)
- [`ProjectReference`](./src/project-reference.mts)
- [`TargetMap`](./src/target-map.mts)
- [`Target`](./src/target.mts)
- [`Tsconfig`](./src/tsconfig.mts)
- alias: `TsconfigJson`
- [`TypeAcquisition`](./src/type-acquisition.mts)
- [`WatchDirectoryMap`](./src/watch-directory-map.mts)
- [`WatchDirectory`](./src/watch-directory.mts)
- [`WatchFileMap`](./src/watch-file-map.mts)
- [`WatchFile`](./src/watch-file.mts)
- [`WatchOptions`](./src/watch-options.mts)
## Related
- [`pkg-types`][pkg-types] — TypeScript definitions for `package.json`
- [`tsconfig-utils`][tsconfig-utils] — Utilities for working with [`tsconfig`][tsconfig] files
## Contribute
See [`CONTRIBUTING.md`](CONTRIBUTING.md).
This project has a [code of conduct](./CODE_OF_CONDUCT.md). By interacting with this repository, organization, or
community you agree to abide by its terms.
[pkg-types]: https://github.com/flex-development/pkg-types
[tsconfig-utils]: https://github.com/flex-development/tsconfig-utils
[tsconfig]: https://www.typescriptlang.org/tsconfig
[typescript]: https://www.typescriptlang.org
[yarn]: https://yarnpkg.com