Skip to content

@snailicide/build-config / tsconfig / TsConfigJson

TsConfigJson

ts
type TsConfigJson = {
  compilerOptions?: CompilerOptions;
  watchOptions?: WatchOptions;
  typeAcquisition?: TypeAcquisition;
  compileOnSave?: boolean;
  extends?: string | string[];
  files?: string[];
  exclude?: string[];
  include?: string[];
  references?: References[];
};

Defined in: node_modules/.pnpm/type-fest@4.41.0/node_modules/type-fest/source/tsconfig-json.d.ts:1

Type for TypeScript's tsconfig.json file (TypeScript 3.7).

Properties

PropertyTypeDescriptionDefined in
compilerOptions?CompilerOptionsInstructs the TypeScript compiler how to compile .ts files.node_modules/.pnpm/type-fest@4.41.0/node_modules/type-fest/source/tsconfig-json.d.ts:1249
watchOptions?WatchOptionsInstructs the TypeScript compiler how to watch files.node_modules/.pnpm/type-fest@4.41.0/node_modules/type-fest/source/tsconfig-json.d.ts:1254
typeAcquisition?TypeAcquisitionAuto type (.d.ts) acquisition options for this project.node_modules/.pnpm/type-fest@4.41.0/node_modules/type-fest/source/tsconfig-json.d.ts:1259
compileOnSave?booleanEnable Compile-on-Save for this project.node_modules/.pnpm/type-fest@4.41.0/node_modules/type-fest/source/tsconfig-json.d.ts:1264
extends?string | string[]Path to base configuration file to inherit from.node_modules/.pnpm/type-fest@4.41.0/node_modules/type-fest/source/tsconfig-json.d.ts:1269
files?string[]If no files or include property is present in a tsconfig.json, the compiler defaults to including all files in the containing directory and subdirectories except those specified by exclude. When a files property is specified, only those files and those specified by include are included.node_modules/.pnpm/type-fest@4.41.0/node_modules/type-fest/source/tsconfig-json.d.ts:1274
exclude?string[]Specifies a list of files to be excluded from compilation. The exclude property only affects the files included via the include property and not the files property. Glob patterns require TypeScript version 2.0 or later.node_modules/.pnpm/type-fest@4.41.0/node_modules/type-fest/source/tsconfig-json.d.ts:1281
include?string[]Specifies a list of glob patterns that match files to be included in compilation. If no files or include property is present in a tsconfig.json, the compiler defaults to including all files in the containing directory and subdirectories except those specified by exclude.node_modules/.pnpm/type-fest@4.41.0/node_modules/type-fest/source/tsconfig-json.d.ts:1288
references?References[]Referenced projects.node_modules/.pnpm/type-fest@4.41.0/node_modules/type-fest/source/tsconfig-json.d.ts:1293