├── src ├── index.mts ├── index.cts ├── typeUtils.ts ├── types.ts ├── lib.ts ├── index.test.ts ├── index.test-d.ts └── types.test-d.ts ├── .prettierrc ├── .gitignore ├── .github └── workflows │ └── publish.yml ├── package.json ├── LICENSE ├── README.md └── tsconfig.json /src/index.mts: -------------------------------------------------------------------------------- 1 | export * from './lib.js'; 2 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "trailingComma": "all" 3 | } -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /node_modules 2 | /dist 3 | 4 | tsconfig.vitest-temp.json -------------------------------------------------------------------------------- /src/index.cts: -------------------------------------------------------------------------------- 1 | import * as lib from "./lib.js"; 2 | 3 | export = lib; 4 | -------------------------------------------------------------------------------- /src/typeUtils.ts: -------------------------------------------------------------------------------- 1 | export type IsNever = [T] extends [never] ? true : false; 2 | 3 | export type FilterCertainIntegers = N extends number 4 | ? IsCertainlyInteger extends true 5 | ? N 6 | : never 7 | : never; 8 | 9 | export type IsCertainlyInteger = 10 | IsCertainlyIntegerImpl<`${N}`>; 11 | 12 | type IsCertainlyIntegerImpl = 13 | Str extends `${infer _}.${infer _}` 14 | ? false 15 | : Str extends `-${infer _}` 16 | ? false 17 | : Str extends "Infinity" | "-Infinity" | "NaN" 18 | ? false 19 | : true; 20 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish 2 | 3 | permissions: 4 | contents: write 5 | 6 | on: 7 | push: 8 | tags: 9 | - v*.*.* 10 | 11 | jobs: 12 | publish: 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - name: Checkout 17 | uses: actions/checkout@v3 18 | with: 19 | fetch-depth: 0 20 | 21 | - name: Install Node.js 22 | uses: actions/setup-node@v3 23 | with: 24 | node-version: 20 25 | registry-url: 'https://registry.npmjs.org' 26 | 27 | - name: Install dependencies 28 | run: npm ci 29 | 30 | - name: Build 31 | run: npm run build 32 | 33 | - name: Publish 34 | run: npm -r publish --access public --no-git-checks 35 | env: 36 | NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}} 37 | 38 | - name: Create release 39 | run: npx changelogithub 40 | env: 41 | GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} 42 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "ts-array-length", 3 | "version": "0.1.3", 4 | "description": "TypeScript utils for dealing with TypeScript arrays", 5 | "main": "dist/index.cjs", 6 | "module": "dist/index.mjs", 7 | "types": "dist/index.d.mts", 8 | "exports": { 9 | ".": { 10 | "import": "./dist/index.mjs", 11 | "require": "./dist/index.cjs", 12 | "types": "./dist/index.d.mts", 13 | "node": "./dist/index.cjs" 14 | } 15 | }, 16 | "scripts": { 17 | "release": "bumpp", 18 | "build": "tsc", 19 | "build:watch": "tsc -w", 20 | "test": "vitest", 21 | "test-type": "vitest typecheck" 22 | }, 23 | "repository": "github:uhyo/ts-array-length", 24 | "keywords": [ 25 | "typescript", 26 | "array", 27 | "length" 28 | ], 29 | "files": [ 30 | "dist", 31 | "src" 32 | ], 33 | "author": "uhyo ", 34 | "license": "MIT", 35 | "devDependencies": { 36 | "bumpp": "^9.4.1", 37 | "prettier": "^2.8.4", 38 | "typescript": "^5.5.3", 39 | "vitest": "^1.6.0" 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 uhyo 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /src/types.ts: -------------------------------------------------------------------------------- 1 | import { 2 | FilterCertainIntegers, 3 | IsCertainlyInteger, 4 | IsNever, 5 | } from "./typeUtils.js"; 6 | 7 | export type ReadonlyArrayExactLength = N extends number 8 | ? number extends N 9 | ? readonly T[] 10 | : IsCertainlyInteger extends true 11 | ? ReadonlyArrayExactLengthRec 12 | : readonly T[] 13 | : never; 14 | 15 | type ReadonlyArrayExactLengthRec< 16 | T, 17 | L extends number, 18 | Result extends readonly T[], 19 | > = Result["length"] extends L 20 | ? Result 21 | : ReadonlyArrayExactLengthRec; 22 | 23 | export type ReadonlyArrayMinLength = number extends N 24 | ? readonly T[] 25 | : FilterCertainIntegers extends infer N extends number 26 | ? IsNever extends true 27 | ? readonly T[] 28 | : ReadonlyArrayMinLengthRec 29 | : readonly T[]; 30 | 31 | type ReadonlyArrayMinLengthRec< 32 | T, 33 | L extends number, 34 | Counter extends readonly unknown[], 35 | Result extends readonly T[], 36 | > = Counter["length"] extends L 37 | ? Result 38 | : ReadonlyArrayMinLengthRec< 39 | T, 40 | L, 41 | [unknown, ...Counter], 42 | readonly [T, ...Result] 43 | >; 44 | -------------------------------------------------------------------------------- /src/lib.ts: -------------------------------------------------------------------------------- 1 | import type { 2 | ReadonlyArrayExactLength, 3 | ReadonlyArrayMinLength, 4 | } from "./types.js"; 5 | 6 | export type { ReadonlyArrayExactLength, ReadonlyArrayMinLength }; 7 | 8 | /** 9 | * Checks whether given array's length is equal to given number. 10 | * 11 | * @example 12 | * ```ts 13 | * hasLength(arr, 1) // equivalent to arr.length === 1 14 | * ``` 15 | */ 16 | export function hasLength( 17 | arr: readonly T[], 18 | length: N, 19 | ): arr is ReadonlyArrayExactLength { 20 | return arr.length === length; 21 | } 22 | 23 | /** 24 | * Checks whether given array's length is greather than or equal to given number. 25 | * 26 | * @example 27 | * ```ts 28 | * hasMinLength(arr, 1) // equivalent to arr.length >= 1 29 | * ``` 30 | */ 31 | export function hasMinLength( 32 | arr: readonly T[], 33 | length: N, 34 | ): arr is ReadonlyArrayMinLength { 35 | return arr.length >= length; 36 | } 37 | 38 | /** 39 | * Checks whether given array is not empty. 40 | * 41 | * @example 42 | * ```ts 43 | * isNonEmpty(arr) // equivalent to arr.length > 0 44 | * ``` 45 | */ 46 | export function isNonEmpty( 47 | arr: readonly T[], 48 | ): arr is ReadonlyArrayMinLength { 49 | return arr.length >= 1; 50 | } 51 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ts-array-length 2 | 3 | TypeScript utilities for dealing with array length. Of course, type predicates inside. 4 | 5 | Useful for codebase with `noUncheckedIndexedAccess` turned on. 6 | 7 | ## Installation 8 | 9 | ``` 10 | npm i -D ts-array-length 11 | ``` 12 | 13 | ## API: functions 14 | 15 | ### `hasLength(arr, len)` 16 | 17 | Returns `true` if `arr.length === len`. 18 | 19 | #### Example 20 | 21 | ```ts 22 | // const arr: string[] 23 | 24 | if (hasLength(arr, 1)) { 25 | // arr: readonly [string] 26 | const str: string = arr[0]; 27 | } 28 | ``` 29 | 30 | ### `hasMinLength(arr, len)` 31 | 32 | Returns `true` if `arr.length >= len`. 33 | 34 | #### Example 35 | 36 | ```ts 37 | // const arr: string[] 38 | 39 | if (hasMinLength(arr, 1)) { 40 | // arr: readonly [string, ...string[]] 41 | const str: string = arr[0]; 42 | } 43 | ``` 44 | 45 | ### `isNonEmpty(arr)` 46 | 47 | Returns `true` if `arr.length >= 1`. 48 | 49 | #### Example 50 | 51 | ```ts 52 | // const arr: string[] 53 | 54 | if (isNonEmpty(arr)) { 55 | // arr: readonly [string, ...string[]] 56 | const str: string = arr[0]; 57 | } 58 | ``` 59 | 60 | ## API: utility types 61 | 62 | ### `ReadonlyArrayExactLength` 63 | 64 | Tuple type whose element type is `T` and has exact length `N`. 65 | 66 | ```ts 67 | // readonly [string, string, string] 68 | type SSS = ReadonlyArrayExactLength; 69 | ``` 70 | 71 | ### `ReadonlyArrayMinLength` 72 | 73 | Tuple type whose element type is `T` and has at least `N` elements. 74 | 75 | ```ts 76 | // readonly [string, string, string, ...string[]] 77 | type SSS = ReadonlyArrayMinLength; 78 | ``` 79 | 80 | ## License 81 | 82 | MIT -------------------------------------------------------------------------------- /src/index.test.ts: -------------------------------------------------------------------------------- 1 | import { describe, expect, it } from "vitest"; 2 | import { hasLength, hasMinLength, isNonEmpty } from "./lib.js"; 3 | 4 | describe("hasLength", () => { 5 | it("Returns true if array has given length", () => { 6 | expect(hasLength([], 0)).toBe(true); 7 | expect(hasLength([], -0)).toBe(true); 8 | 9 | expect(hasLength([1, 2, 3], 3)).toBe(true); 10 | }); 11 | it("Returns false if array does not have given length", () => { 12 | expect(hasLength([], 5)).toBe(false); 13 | expect(hasLength([], -1)).toBe(false); 14 | expect(hasLength([], 0.5)).toBe(false); 15 | 16 | expect(hasLength([1, 2, 3], 0)).toBe(false); 17 | }); 18 | }); 19 | 20 | describe("hasMinLength", () => { 21 | it("Returns true if array has or is longer than given length", () => { 22 | expect(hasMinLength([], 0)).toBe(true); 23 | expect(hasMinLength([], -0)).toBe(true); 24 | expect(hasMinLength([], -1)).toBe(true); 25 | 26 | expect(hasMinLength([1, 2, 3], 0)).toBe(true); 27 | expect(hasMinLength([1, 2, 3], 1)).toBe(true); 28 | expect(hasMinLength([1, 2, 3], 2)).toBe(true); 29 | expect(hasMinLength([1, 2, 3], 3)).toBe(true); 30 | }); 31 | it("Returns false if array is shorter than given length", () => { 32 | expect(hasMinLength([], 5)).toBe(false); 33 | expect(hasMinLength([], 1)).toBe(false); 34 | expect(hasMinLength([], 0.5)).toBe(false); 35 | 36 | expect(hasMinLength([1, 2, 3], 4)).toBe(false); 37 | expect(hasMinLength([1, 2, 3], 10)).toBe(false); 38 | }); 39 | }); 40 | 41 | describe("isNonEmpty", () => { 42 | it("Returns true if given array is not empty", () => { 43 | expect(isNonEmpty([1, 2, 3])).toBe(true); 44 | expect(isNonEmpty([1])).toBe(true); 45 | expect(isNonEmpty([,])).toBe(true); 46 | }); 47 | it("Returns false if array is empty", () => { 48 | expect(isNonEmpty([])).toBe(false); 49 | }); 50 | }); 51 | -------------------------------------------------------------------------------- /src/index.test-d.ts: -------------------------------------------------------------------------------- 1 | import { describe, it, assertType } from "vitest"; 2 | import { hasLength, hasMinLength, isNonEmpty } from "./index.cjs"; 3 | 4 | function getArr(): readonly T[] { 5 | return []; 6 | } 7 | 8 | describe("hasLength", () => { 9 | it("hasLength(0) narrows arr to an empty tuple type", () => { 10 | const arr = getArr(); 11 | 12 | if (hasLength(arr, 0)) { 13 | assertType(arr); 14 | } else { 15 | assertType(arr); 16 | } 17 | }); 18 | it("hasLength(2) narrows arr to a 2-tuple type", () => { 19 | const arr = getArr(); 20 | 21 | if (hasLength(arr, 2)) { 22 | assertType(arr); 23 | // @ts-expect-error 24 | arr[2]; 25 | } else { 26 | assertType(arr); 27 | } 28 | }); 29 | }); 30 | 31 | describe("hasMinLength", () => { 32 | it("hasMinLength(0) does nothing", () => { 33 | const arr = getArr(); 34 | 35 | if (hasMinLength(arr, 0)) { 36 | assertType(arr); 37 | } else { 38 | assertType(arr); 39 | } 40 | }); 41 | it("hasMinLength(2) narrows arr to a 2-tuple type with rest elements", () => { 42 | const arr = getArr(); 43 | 44 | if (hasMinLength(arr, 2)) { 45 | assertType(arr); 46 | assertType(arr[0]); 47 | assertType(arr[1]); 48 | assertType(arr[2]); 49 | assertType(arr[3]); 50 | } else { 51 | assertType(arr); 52 | } 53 | }); 54 | }); 55 | 56 | describe("isNonEmpty", () => { 57 | it("isNonEmpty() narrows arr to a 1-tuple with rest elements", () => { 58 | const arr = getArr(); 59 | 60 | if (isNonEmpty(arr)) { 61 | assertType(arr); 62 | } else { 63 | assertType(arr); 64 | } 65 | }); 66 | }); 67 | -------------------------------------------------------------------------------- /src/types.test-d.ts: -------------------------------------------------------------------------------- 1 | import { expectTypeOf, describe, it } from "vitest"; 2 | import { hasLength, hasMinLength } from "./index.cjs"; 3 | import { ReadonlyArrayExactLength, ReadonlyArrayMinLength } from "./types.js"; 4 | 5 | describe("ReadonlyArrayExactLength", () => { 6 | it("When a non-negative integer literal number type is given, it works", () => { 7 | expectTypeOf>().toEqualTypeOf< 8 | readonly [] 9 | >(); 10 | expectTypeOf>().toEqualTypeOf< 11 | readonly [string] 12 | >(); 13 | expectTypeOf>().not.toEqualTypeOf< 14 | readonly [string, ...string[]] 15 | >(); 16 | }); 17 | 18 | it("It works for a union of literal number types", () => { 19 | expectTypeOf>().toEqualTypeOf< 20 | | readonly [string] 21 | | readonly [string, string] 22 | | readonly [string, string, string] 23 | >(); 24 | }); 25 | 26 | it("When a negative or non-integer literal number is given, it gives up and falls back to normal array type", () => { 27 | expectTypeOf>().toEqualTypeOf< 28 | readonly boolean[] 29 | >(); 30 | expectTypeOf>().toEqualTypeOf< 31 | readonly boolean[] 32 | >(); 33 | expectTypeOf>().toEqualTypeOf< 34 | readonly boolean[] 35 | >(); 36 | expectTypeOf>().toEqualTypeOf< 37 | readonly boolean[] 38 | >(); 39 | expectTypeOf>().toEqualTypeOf< 40 | | readonly boolean[] 41 | | readonly [boolean, boolean, boolean, boolean, boolean] 42 | >(); 43 | }); 44 | 45 | it("When a number type is given, it returns normal array type", () => { 46 | expectTypeOf>().toEqualTypeOf< 47 | readonly boolean[] 48 | >(); 49 | }); 50 | 51 | it("Does not complain about type parameters", () => { 52 | function func(num: N) { 53 | type A = ReadonlyArrayExactLength; 54 | const arr = ["pika", "chu"]; 55 | if (hasLength(arr, num)) { 56 | const a: A = arr; 57 | return a[0]; 58 | } 59 | return ""; 60 | } 61 | }); 62 | }); 63 | 64 | describe("ReadonlyArrayMinLength", () => { 65 | it("When a non-negative integer literal number type is given, it works", () => { 66 | expectTypeOf>().toEqualTypeOf< 67 | readonly string[] 68 | >(); 69 | expectTypeOf>().toEqualTypeOf< 70 | readonly [string, ...string[]] 71 | >(); 72 | }); 73 | 74 | it("When a union of literal number types are given, the minimum is used", () => { 75 | expectTypeOf>().toEqualTypeOf< 76 | readonly [string, ...string[]] 77 | >(); 78 | }); 79 | 80 | it("When a negative or non-integer literal number is given, it gives up and falls back to normal array type", () => { 81 | expectTypeOf>().toEqualTypeOf< 82 | readonly boolean[] 83 | >(); 84 | expectTypeOf>().toEqualTypeOf< 85 | readonly boolean[] 86 | >(); 87 | expectTypeOf>().toEqualTypeOf< 88 | readonly boolean[] 89 | >(); 90 | expectTypeOf>().toEqualTypeOf< 91 | readonly boolean[] 92 | >(); 93 | expectTypeOf>().toEqualTypeOf< 94 | readonly [boolean, boolean, boolean, boolean, boolean, ...boolean[]] 95 | >(); 96 | }); 97 | 98 | it("When a number type is given, it returns normal array type", () => { 99 | expectTypeOf>().toEqualTypeOf< 100 | readonly boolean[] 101 | >(); 102 | }); 103 | 104 | it("Does not complain about type parameters", () => { 105 | function func(num: N) { 106 | type A = ReadonlyArrayMinLength; 107 | const arr = ["pika", "chu"]; 108 | if (hasMinLength(arr, num)) { 109 | const a: A = arr; 110 | return a[0]; 111 | } 112 | return ""; 113 | } 114 | }); 115 | }); 116 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | /* Visit https://aka.ms/tsconfig to read more about this file */ 4 | /* Projects */ 5 | // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ 6 | // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ 7 | // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ 8 | // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ 9 | // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ 10 | // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ 11 | /* Language and Environment */ 12 | "target": "es2022", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ 13 | // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ 14 | // "jsx": "preserve", /* Specify what JSX code is generated. */ 15 | // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ 16 | // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ 17 | // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ 18 | // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ 19 | // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ 20 | // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ 21 | // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ 22 | // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ 23 | // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ 24 | /* Modules */ 25 | "module": "node16", /* Specify what module code is generated. */ 26 | // "rootDir": "./", /* Specify the root folder within your source files. */ 27 | "moduleResolution": "node16", /* Specify how TypeScript looks up a file from a given module specifier. */ 28 | // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ 29 | // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ 30 | // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ 31 | // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ 32 | // "types": [], /* Specify type package names to be included without being referenced in a source file. */ 33 | // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ 34 | // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ 35 | // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ 36 | // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ 37 | // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ 38 | // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ 39 | // "resolveJsonModule": true, /* Enable importing .json files. */ 40 | // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ 41 | // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ 42 | /* JavaScript Support */ 43 | // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ 44 | // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ 45 | // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ 46 | /* Emit */ 47 | "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ 48 | "declarationMap": true, /* Create sourcemaps for d.ts files. */ 49 | // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ 50 | "sourceMap": true, /* Create source map files for emitted JavaScript files. */ 51 | // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ 52 | // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ 53 | "outDir": "./dist", /* Specify an output folder for all emitted files. */ 54 | // "removeComments": true, /* Disable emitting comments. */ 55 | // "noEmit": true, /* Disable emitting files from a compilation. */ 56 | // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ 57 | // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ 58 | // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ 59 | // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ 60 | // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ 61 | // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ 62 | // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ 63 | // "newLine": "crlf", /* Set the newline character for emitting files. */ 64 | // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ 65 | // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ 66 | // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ 67 | // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ 68 | // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ 69 | // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ 70 | /* Interop Constraints */ 71 | // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ 72 | // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ 73 | // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ 74 | "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ 75 | // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ 76 | "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ 77 | /* Type Checking */ 78 | "strict": true, /* Enable all strict type-checking options. */ 79 | // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ 80 | // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ 81 | // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ 82 | // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ 83 | // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ 84 | // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ 85 | // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ 86 | // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ 87 | // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ 88 | // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ 89 | // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ 90 | // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ 91 | // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ 92 | "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ 93 | // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ 94 | // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ 95 | // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ 96 | // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ 97 | /* Completeness */ 98 | // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ 99 | "skipLibCheck": true /* Skip type checking all .d.ts files. */ 100 | }, 101 | "include": [ 102 | "src" 103 | ] 104 | } 105 | --------------------------------------------------------------------------------