npm - http-snapshotter - Versions diffs - 0.1.2 → 0.1.4 - Mend

http-snapshotter 0.1.2 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/README.md CHANGED Viewed

@@ -2,6 +2,8 @@
 Take snapshots of HTTP requests for purpose of tests (on node.js).
+Use-case: Let's say you are testing a server end-point, that makes several external network requests before giving a response. In a unit test you would want any external network call to be stubbed/mocked. What one wants is to test the end-point for a fixed input and fixed responses of external network calls. Stubs take quite a while to write, rather create snapshots of the requests automatically by HTTP Snapshotter and only write test code for the end-point input and output.
 WARNING: This module isn't concurrent or thread safe yet. You can only use it on serial test runners like `tape`.
 Example (test.js):
@@ -43,6 +45,8 @@ Tip: When you do `SNAPSHOT=update` to create snapshots, run it against a single
 Finally after getting all your tests to use snapshots, run your test runner against all your tests and then take a look at `<snapshots directory>/unused-snapshots.log` file to see which snapshot files haven't been used by your final test suite. You can delete unused snapshot files.
+The tests of this library uses this library itself, check the `tests/` directory and try the tests `npm ci; npm test`.
 ## About snapshot files and its names
 A snapshot file name unique identifies a request. By default it is a combination of HTTP method + URL + body that makes a request unique.

package/index.d.ts ADDED Viewed

@@ -0,0 +1,92 @@
+export type SnapshotText = {
+    responseType: 'text';
+    fileSuffixKey: string;
+    request: {
+        method: string;
+        url: string;
+        headers: string[][];
+        body: string | undefined;
+    };
+    response: {
+        status: number;
+        statusText: string;
+        headers: string[][];
+        body: string | undefined;
+    };
+};
+export type SnapshotJson = {
+    responseType: 'json';
+    fileSuffixKey: string;
+    request: {
+        method: string;
+        url: string;
+        headers: string[][];
+        body: string | undefined;
+    };
+    response: {
+        status: number;
+        statusText: string;
+        headers: string[][];
+        body: object | undefined;
+    };
+};
+export type Snapshot = SnapshotText | SnapshotJson;
+export type ClientRequestInterceptorType = import('@mswjs/interceptors/ClientRequest').ClientRequestInterceptor;
+export type FetchInterceptorType = import('@mswjs/interceptors/fetch').FetchInterceptor;
+/**
+ * @param {Request} request
+ */
+export function defaultSnapshotFileNameGenerator(request: Request): Promise<{
+    filePrefix: string;
+    fileSuffixKey: string;
+}>;
+/**
+ * Attach snapshot filename generator function
+ *
+ * Here's your opportunity to uniquely identify a request with a snapshot file name.
+ * The default generator uses HTTP method, slugified URL (check @sindresorhus/slugify
+ * npm package) as the file name prefix
+ * And <HTTP method>#<url>#<body text> concatenated as file name suffix key
+ * (which then is SHA256 hashed and the hash is used as the actual file name suffix).
+ *
+ * Use cases (not limited to):
+ * 1. if a request body has a dynamic random id or timestamp, you can remove it from
+ * cache key computation
+ * 2. if a specific test does not use the default snapshot, you can prefix the snapshot
+ * file name for the test.
+ *
+ * WARNING: Attaching a function on a per-test basis may not be concurrent safe. i.e. If you tests
+ * run sequentially, then it is safe. But if your test runner runs test suites concurrently,
+ * then it is better to attach a function only once ever.
+ * @param {(req: Request) => Promise<{ filePrefix: string, fileSuffixKey: string }>} func
+ */
+export function attachSnapshotFilenameGenerator(func: (req: Request) => Promise<{
+    filePrefix: string;
+    fileSuffixKey: string;
+}>): void;
+/** Reset snapshot filename generator to default */
+export function resetSnapshotFilenameGenerator(): void;
+/**
+ * Attach response transformer function.
+ *
+ * Here is an opportunity to modify the response (loaded from snapshot) on-the-fly right before
+ * the response is sent to consumers.
+ *
+ * WARNING: Attaching a function on a per-test basis may not be concurrent safe. i.e. If you tests
+ * run sequentially, then it is safe. But if your test runner runs test suites concurrently,
+ * then it is better to attach a function only once ever.
+ * @param {(response: Response, request: Request) => Promise<Response>} func
+ */
+export function attachResponseTransformer(func: (response: Response, request: Request) => Promise<Response>): void;
+/** Reset response transformer */
+export function resetResponseTransformer(): void;
+/**
+ * Start the interceptor
+ * @param {object} opts
+ * @param {string|null} opts.snapshotDirectory Full absolute path to snapshot directory
+ */
+export function start({ snapshotDirectory: _snapshotDirectory, }?: {
+    snapshotDirectory: string | null;
+}): void;
+/** Stop the interceptor */
+export function stop(): void;

package/index.js CHANGED Viewed

@@ -35,6 +35,9 @@ const { resolve } = require('node:path');
 const SNAPSHOT = process.env.SNAPSHOT || 'read';
 const LOG_REQ = process.env.LOG_REQ === '1' || process.env.LOG_REQ === 'true';
 const unusedSnapshotsLogFile = 'unused-snapshots.log';
+/**
+ * @type {import("node:fs").PathLike | null}
+ */
 let snapshotDirectory = null;
 /**
@@ -72,9 +75,13 @@ let snapshotDirectory = null;
  * @typedef {SnapshotText | SnapshotJson} Snapshot
  */
+/** @type {(res: any) => any} */
 const identity = (response) => response;
 const defaultKeyDerivationProps = ['method', 'url', 'body'];
+/**
+ * @param {Request} request
+ */
 async function defaultSnapshotFileNameGenerator(request) {
   const url = new URL(request.url);
   const filePrefix = [
@@ -89,6 +96,7 @@ async function defaultSnapshotFileNameGenerator(request) {
       if (key === 'body') {
         return request.clone().text();
       }
+      // @ts-ignore
       return request[key];
     }),
   );
@@ -124,7 +132,7 @@ async function getSnapshotFileName(request) {
   const fileName = `${filePrefix}-${hash}.json`;
   return {
-    absoluteFilePath: resolve(snapshotDirectory, fileName),
+    absoluteFilePath: resolve(/** @type {string} */ (snapshotDirectory), fileName),
     fileName,
     filePrefix,
     fileSuffixKey,
@@ -180,7 +188,9 @@ async function saveSnapshot(request, response) {
   return fileName;
 }
+/** @type {Record<string, Snapshot>} */
 const snapshotCache = {};
 /**
  * @param {Request} request
  */
@@ -230,7 +240,9 @@ async function enforceSnapshotResponse(request) {
   } = snapshot;
   let newResponse = new Response(
-    responseType === 'json' ? JSON.stringify(body) : body,
+    responseType === 'json'
+      ? JSON.stringify(body)
+      : /** @type {string} */ (body),
     {
       status,
       statusText,
@@ -246,8 +258,10 @@ async function enforceSnapshotResponse(request) {
   return newResponse;
 }
+/** @typedef {import('@mswjs/interceptors/ClientRequest').ClientRequestInterceptor} ClientRequestInterceptorType */
+/** @typedef {import('@mswjs/interceptors/fetch').FetchInterceptor} FetchInterceptorType */
 /**
- * @type {import('@mswjs/interceptors').BatchInterceptor|null}
+ * @type {import('@mswjs/interceptors').BatchInterceptor<(ClientRequestInterceptorType|FetchInterceptorType)[]>|null}
  */
 let interceptor = null;
@@ -258,22 +272,24 @@ process.on('beforeExit', async () => {
     beforeExitEventSeen = true;
     let files;
     try {
+      // @ts-ignore
       files = await fs.readdir(snapshotDirectory);
     } catch (err) {
       return;
     }
+    let dir = /** @type {string} */(snapshotDirectory);
     unusedFiles = files.filter((file) => !readFiles.has(file) && file !== unusedSnapshotsLogFile);
     if (unusedFiles.length) {
       await fs
         .writeFile(
-          resolve(snapshotDirectory, unusedSnapshotsLogFile),
+          resolve(dir, unusedSnapshotsLogFile),
           unusedFiles.join('\n'),
           'utf-8',
         )
         .catch((err) => console.error(err));
     } else {
       await fs
-        .unlink(resolve(snapshotDirectory, unusedSnapshotsLogFile))
+        .unlink(resolve(dir, unusedSnapshotsLogFile))
         .catch((err) => {
           if (err.code !== 'ENOENT') {
             console.error(err);
@@ -283,27 +299,60 @@ process.on('beforeExit', async () => {
   }
 });
-// Attach snapshot filename generator function
+/**
+ * Attach snapshot filename generator function
+ *
+ * Here's your opportunity to uniquely identify a request with a snapshot file name.
+ * The default generator uses HTTP method, slugified URL (check @sindresorhus/slugify
+ * npm package) as the file name prefix
+ * And <HTTP method>#<url>#<body text> concatenated as file name suffix key
+ * (which then is SHA256 hashed and the hash is used as the actual file name suffix).
+ *
+ * Use cases (not limited to):
+ * 1. if a request body has a dynamic random id or timestamp, you can remove it from
+ * cache key computation
+ * 2. if a specific test does not use the default snapshot, you can prefix the snapshot
+ * file name for the test.
+ *
+ * WARNING: Attaching a function on a per-test basis may not be concurrent safe. i.e. If you tests
+ * run sequentially, then it is safe. But if your test runner runs test suites concurrently,
+ * then it is better to attach a function only once ever.
+ * @param {(req: Request) => Promise<{ filePrefix: string, fileSuffixKey: string }>} func
+ */
 function attachSnapshotFilenameGenerator(func) {
   snapshotFileNameGenerator = func;
 }
-// Reset snapshot filename generator to default
+/** Reset snapshot filename generator to default */
 function resetSnapshotFilenameGenerator() {
   snapshotFileNameGenerator = defaultSnapshotFileNameGenerator;
 }
-// Attach response transformer function
+/**
+ * Attach response transformer function.
+ *
+ * Here is an opportunity to modify the response (loaded from snapshot) on-the-fly right before
+ * the response is sent to consumers.
+ *
+ * WARNING: Attaching a function on a per-test basis may not be concurrent safe. i.e. If you tests
+ * run sequentially, then it is safe. But if your test runner runs test suites concurrently,
+ * then it is better to attach a function only once ever.
+ * @param {(response: Response, request: Request) => Promise<Response>} func
+ */
 function attachResponseTransformer(func) {
   responseTransformer = func;
 }
-// Reset response transformer
+/** Reset response transformer */
 function resetResponseTransformer() {
   responseTransformer = identity;
 }
-// Start the interceptor
+/**
+ * Start the interceptor
+ * @param {object} opts
+ * @param {string|null} opts.snapshotDirectory Full absolute path to snapshot directory
+ */
 function start({
   snapshotDirectory: _snapshotDirectory = null,
 } = { snapshotDirectory: null }) {
@@ -311,6 +360,9 @@ function start({
     throw new Error('Please specify full path to a directory for storing/reading snapshots');
   }
   snapshotDirectory = _snapshotDirectory;
+  /**
+   * @type {Promise<any>|undefined}
+   */
   let dirCreatePromise;
   interceptor = new BatchInterceptor({
@@ -321,37 +373,43 @@ function start({
     ],
   });
+  // @ts-ignore
   interceptor.on('request', async ({ request }) => {
     if (SNAPSHOT === 'read') {
       await enforceSnapshotResponse(request);
     }
   });
-  interceptor.on('response', async ({ request, response }) => {
-    if (SNAPSHOT === 'update') {
-      if (!dirCreatePromise) {
-        dirCreatePromise = fs.mkdir(snapshotDirectory, { recursive: true });
+  interceptor.on(
+    // @ts-ignore
+    'response',
+    /** @type {(params: { request: Request, response: Response }) => Promise<void>} */
+    async ({ request, response }) => {
+      if (SNAPSHOT === 'update') {
+        if (!dirCreatePromise) {
+          dirCreatePromise = fs.mkdir( /** @type {string} */(snapshotDirectory), { recursive: true });
+        }
+        await dirCreatePromise;
+        saveSnapshot(request, response);
       }
-      await dirCreatePromise;
-      saveSnapshot(request, response);
-    }
-    if (LOG_REQ) {
-      const { fileName, fileSuffixKey } = await getSnapshotFileName(request);
-      console.debug('Request', {
-        request: {
-          url: request.url,
-          method: request.method,
-          headers: Object.fromEntries([...request.headers.entries()]),
-          body: await request.clone().text(),
-        },
-        wouldBeFileName: fileName,
-        wouldBeFileSuffixKey: fileSuffixKey,
-      });
-    }
-  });
+      if (LOG_REQ) {
+        const { fileName, fileSuffixKey } = await getSnapshotFileName(request);
+        console.debug('Request', {
+          request: {
+            url: request.url,
+            method: request.method,
+            headers: Object.fromEntries([...request.headers.entries()]),
+            body: await request.clone().text(),
+          },
+          wouldBeFileName: fileName,
+          wouldBeFileSuffixKey: fileSuffixKey,
+        });
+      }
+    },
+  );
   interceptor.apply();
 }
-// Stop the interceptor
+/** Stop the interceptor */
 function stop() {
   if (interceptor) {
     interceptor.dispose();

package/package.json CHANGED Viewed

@@ -1,14 +1,16 @@
 {
   "name": "http-snapshotter",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Snapshot HTTP requests for tests (node.js)",
   "main": "index.cjs",
+  "types": "index.d.ts",
   "exports": {
     "import": "./index.mjs",
     "require": "./index.js"
   },
   "scripts": {
-    "test": "tape tests/**/*.test.* | tap-diff"
+    "test": "tape tests/**/*.test.* | tap-diff",
+    "tsc": "tsc"
   },
   "keywords": [
     "snapshot",
@@ -25,6 +27,7 @@
     "@sindresorhus/slugify": "^1.1.2"
   },
   "devDependencies": {
+    "@types/node": "^20.6.2",
     "tap-diff": "^0.1.1",
     "tape": "^5.6.6",
     "typescript": "^5.2.2"

package/tsconfig-old.json ADDED Viewed

@@ -0,0 +1,76 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "ESNext",                       /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+    "module": "nodenext",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    "allowJs": true,                          /* Allow javascript files to be compiled. */
+    "checkJs": true,                          /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    "declaration": true,                      /* Generates corresponding '.d.ts' file. */
+    "emitDeclarationOnly": true,              /* Generates only a '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    // "outDir": "./",                        /* Redirect output structure to the directory. */
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    "noEmitOnError": true,                    /* Don't generate on error. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    "noImplicitAny": false,                   /* Raise error on expressions and declarations with an implied 'any' type. */
+    "strictNullChecks": true,                 /* Enable strict null checks. */
+    "strictFunctionTypes": true,              /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+    /* Additional Checks */
+    "noUnusedLocals": true,                   /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    "noImplicitReturns": true,                /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+    /* Module Resolution Options */
+    "moduleResolution": "NodeNext",           /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    "typeRoots": [
+      "./node_modules/@types"
+    ],                                        /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": false,                 /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+    /* Advanced Options */
+    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
+    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
+  },
+  "include": [
+    "src/index.js"
+  ]
+}

package/tsconfig.json ADDED Viewed

@@ -0,0 +1,114 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+    /* Language and Environment */
+    "target": "ESNext",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                       /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+    /* Modules */
+    "module": "NodeNext",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    "typeRoots": [
+      "./node_modules/@types"
+    ],                                                   /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+    /* JavaScript Support */
+    "allowJs": true,                                     /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    "checkJs": true,                                     /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+    /* Emit */
+    "declaration": true,                                 /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    "emitDeclarationOnly": true,                         /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "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. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    "noEmitOnError": true,                               /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "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. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    "noImplicitAny": true,                               /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    "strictNullChecks": true,                            /* When type checking, take into account 'null' and 'undefined'. */
+    "strictFunctionTypes": true,                         /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    "noUnusedLocals": true,                              /* Enable error reporting when local variables aren't read. */
+    "noUnusedParameters": true,                          /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    "noImplicitReturns": true,                           /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  },
+  "include": [
+    "index.js"
+  ]
+}