From 1cccd020353fd9cae8109a52a3167df0bc996fc2 Mon Sep 17 00:00:00 2001 From: David Sherret Date: Thu, 18 Feb 2021 13:57:29 -0500 Subject: [PATCH] feat: Bundle typescript package in ts-morph/common (#934) --- docs/setup/file-system.md | 19 - .../bootstrap/lib/ts-morph-bootstrap.d.ts | 21 +- packages/bootstrap/src/Project.ts | 19 +- packages/bootstrap/src/SourceFileCache.ts | 9 + packages/bootstrap/src/index.ts | 4 +- packages/bootstrap/src/tests/projectTests.ts | 88 +- packages/common/lib/ts-morph-common.d.ts | 33 +- packages/common/lib/typescript.d.ts | 7204 +++++++++++++++++ packages/common/package.json | 8 +- packages/common/scripts/buildDeclarations.ts | 4 +- packages/common/scripts/bundleLocalTs.ts | 20 + .../common/src/compiler/DocumentRegistry.ts | 2 +- .../src/compiler/TsSourceFileContainer.ts | 10 + packages/common/src/compiler/createHosts.ts | 92 +- .../src/fileSystem/InMemoryFileSystemHost.ts | 18 +- packages/common/src/getLibFiles.ts | 5 + .../fileSystem/inMemoryFileSystemHostTests.ts | 14 +- .../transactionalFileSystemTests.ts | 2 +- packages/ts-morph/lib/ts-morph.d.ts | 61 +- .../ts-morph/scripts/config/isAllowedMixin.ts | 2 +- .../getDeclarationFileStatements.ts | 5 +- packages/ts-morph/src/Project.ts | 19 +- packages/ts-morph/src/ProjectContext.ts | 36 +- .../compiler/ast/module/ImportSpecifier.ts | 2 +- .../src/compiler/tools/LanguageService.ts | 17 +- packages/ts-morph/src/main.ts | 6 +- .../base/name/ModuleNamedNodeStructure.ts | 3 + .../src/structures/base/name/index.ts | 1 + .../module/ModuleDeclarationStructure.ts | 4 +- .../compiler/testHelpers/getInfoFromText.ts | 36 +- .../tests/compiler/tools/diagnosticTests.ts | 2 +- .../src/tests/compiler/type/typeTests.ts | 2 +- .../ts-morph/src/tests/issues/394tests.ts | 4 +- .../ts-morph/src/tests/issues/534tests.ts | 3 +- packages/ts-morph/src/tests/projectTests.ts | 71 +- .../testHelpers/fileSystemHostHelpers.ts | 2 +- .../src/utils/compiler/createWrappedNode.ts | 2 + 37 files changed, 7600 insertions(+), 250 deletions(-) create mode 100644 packages/common/lib/typescript.d.ts create mode 100644 packages/common/scripts/bundleLocalTs.ts create mode 100644 packages/ts-morph/src/structures/base/name/ModuleNamedNodeStructure.ts diff --git a/docs/setup/file-system.md b/docs/setup/file-system.md index 34603e6f7..95c60b154 100644 --- a/docs/setup/file-system.md +++ b/docs/setup/file-system.md @@ -37,25 +37,6 @@ The current working directory on this file system will be `/`. This file system can also be imported and created via the `InMemoryFileSystemHost` export. -#### `lib.d.ts` files - -Since ts-morph 6.0, the in memory file system will have the [`lib.d.ts` files](https://github.com/Microsoft/TypeScript/tree/master/lib) loaded into the `/node_modules/typescript/lib` folder by default. - -If you want the old behaviour, you can specify to skip loading them by providing a `skipLoadingLibFiles` option: - -```ts ignore-error: 1109 -import { Project, FileSystemHost } from "ts-morph"; - -const project = new Project({ - useInMemoryFileSystem: true, - skipLoadingLibFiles: true -}); - -console.log(project.getFileSystem().directoryExistsSync("/node_modules")); // false -``` - -When using a non-default file system, the library will search for these files in `path.join(fs.getCurrentDirectory(), "node_modules/typescript/lib"))`. - ### Custom File System It's possible to use your own custom file system by implementing the `FileSystemHost` interface then passing in an instance of this when creating a new `Project` instance: diff --git a/packages/bootstrap/lib/ts-morph-bootstrap.d.ts b/packages/bootstrap/lib/ts-morph-bootstrap.d.ts index c3d7c45fa..a455d009a 100644 --- a/packages/bootstrap/lib/ts-morph-bootstrap.d.ts +++ b/packages/bootstrap/lib/ts-morph-bootstrap.d.ts @@ -75,9 +75,8 @@ export interface FileSystemHost { export declare class InMemoryFileSystemHost implements FileSystemHost { /** * Constructor. - * @param options - Options for creating the file system. */ - constructor(options?: InMemoryFileSystemHostOptions); + constructor(); /** @inheritdoc */ isCaseSensitive(): boolean; /** @inheritdoc */ @@ -124,14 +123,6 @@ export declare class InMemoryFileSystemHost implements FileSystemHost { globSync(patterns: ReadonlyArray): string[]; } -export interface InMemoryFileSystemHostOptions { - /** - * Set this to true to not load the /node_modules/typescript/lib files on construction. - * @default false - */ - skipLoadingLibFiles?: boolean; -} - /** Host for implementing custom module and/or type reference directive resolution. */ export interface ResolutionHost { resolveModuleNames?: ts.LanguageServiceHost["resolveModuleNames"]; @@ -194,8 +185,16 @@ export interface ProjectOptions { skipAddingFilesFromTsConfig?: boolean; /** Skip resolving file dependencies when providing a ts config file path and adding the files from tsconfig. @default false */ skipFileDependencyResolution?: boolean; - /** Skip loading the lib files when using an in-memory file system. @default false */ + /** + * Skip loading the lib files. Unlike the compiler API, ts-morph does not load these + * from the node_modules folder, but instead loads them from some other JS code + * and uses a fake path for their existence. If you want to use a custom lib files + * folder path, then provide one using the libFolderPath options. + * @default false + */ skipLoadingLibFiles?: boolean; + /** The folder to use for loading lib files. */ + libFolderPath?: string; /** Whether to use an in-memory file system. */ useInMemoryFileSystem?: boolean; /** diff --git a/packages/bootstrap/src/Project.ts b/packages/bootstrap/src/Project.ts index c9e0bc362..9a48ff5fc 100644 --- a/packages/bootstrap/src/Project.ts +++ b/packages/bootstrap/src/Project.ts @@ -12,8 +12,16 @@ export interface ProjectOptions { skipAddingFilesFromTsConfig?: boolean; /** Skip resolving file dependencies when providing a ts config file path and adding the files from tsconfig. @default false */ skipFileDependencyResolution?: boolean; - /** Skip loading the lib files when using an in-memory file system. @default false */ + /** + * Skip loading the lib files. Unlike the compiler API, ts-morph does not load these + * from the node_modules folder, but instead loads them from some other JS code + * and uses a fake path for their existence. If you want to use a custom lib files + * folder path, then provide one using the libFolderPath options. + * @default false + */ skipLoadingLibFiles?: boolean; + /** The folder to use for loading lib files. */ + libFolderPath?: string; /** Whether to use an in-memory file system. */ useInMemoryFileSystem?: boolean; /** @@ -93,16 +101,11 @@ function createProjectCommon(options: ProjectOptions) { function verifyOptions() { if (options.fileSystem != null && options.useInMemoryFileSystem) throw new errors.InvalidOperationError("Cannot provide a file system when specifying to use an in-memory file system."); - if (options.skipLoadingLibFiles && !options.useInMemoryFileSystem) { - throw new errors.InvalidOperationError( - `The ${nameof(options.skipLoadingLibFiles)} option can only be true when ${nameof(options.useInMemoryFileSystem)} is true.`, - ); - } } function getFileSystem() { if (options.useInMemoryFileSystem) - return new InMemoryFileSystemHost({ skipLoadingLibFiles: options.skipLoadingLibFiles }); + return new InMemoryFileSystemHost(); return options.fileSystem ?? new RealFileSystemHost(); } @@ -159,6 +162,8 @@ export class Project { resolutionHost: resolutionHost || {}, getProjectVersion: () => this._sourceFileCache.getProjectVersion().toString(), isKnownTypesPackageName: options.isKnownTypesPackageName, + libFolderPath: options.libFolderPath, + skipLoadingLibFiles: options.skipLoadingLibFiles, }); this.languageServiceHost = languageServiceHost; this.compilerHost = compilerHost; diff --git a/packages/bootstrap/src/SourceFileCache.ts b/packages/bootstrap/src/SourceFileCache.ts index bf06e4700..32ffcbc4c 100644 --- a/packages/bootstrap/src/SourceFileCache.ts +++ b/packages/bootstrap/src/SourceFileCache.ts @@ -38,6 +38,15 @@ export class SourceFileCache implements TsSourceFileContainer { return this.sourceFilesByFilePath.get(filePath); } + addLibFileToCacheByText(filePath: StandardizedFilePath, fileText: string, scriptKind: ScriptKind | undefined) { + return this.documentRegistry.createOrUpdateSourceFile( + filePath, + this.compilerOptions.get(), + ts.ScriptSnapshot.fromString(fileText), + scriptKind, + ); + } + async addOrGetSourceFileFromFilePath(filePath: StandardizedFilePath, options: { scriptKind: ScriptKind | undefined; }): Promise { let sourceFile = this.sourceFilesByFilePath.get(filePath); if (sourceFile == null && await this.fileSystemWrapper.fileExists(filePath)) { diff --git a/packages/bootstrap/src/index.ts b/packages/bootstrap/src/index.ts index d954bc688..72bd26816 100644 --- a/packages/bootstrap/src/index.ts +++ b/packages/bootstrap/src/index.ts @@ -1,3 +1,3 @@ -export { CompilerOptionsContainer, FileSystemHost, InMemoryFileSystemHost, InMemoryFileSystemHostOptions, ResolutionHost, ResolutionHostFactory, - SettingsContainer, ts } from "@ts-morph/common"; +export { CompilerOptionsContainer, FileSystemHost, InMemoryFileSystemHost, ResolutionHost, ResolutionHostFactory, SettingsContainer, + ts } from "@ts-morph/common"; export * from "./Project"; diff --git a/packages/bootstrap/src/tests/projectTests.ts b/packages/bootstrap/src/tests/projectTests.ts index c8e9a105f..17c39c374 100644 --- a/packages/bootstrap/src/tests/projectTests.ts +++ b/packages/bootstrap/src/tests/projectTests.ts @@ -1,4 +1,4 @@ -import { InMemoryFileSystemHost, ts } from "@ts-morph/common"; +import { getLibFiles, InMemoryFileSystemHost, ts } from "@ts-morph/common"; import { expect } from "chai"; import { EOL } from "os"; import { createProject, createProjectSync, Project, ProjectOptions } from "../Project"; @@ -10,32 +10,46 @@ describe(nameof(Project), () => { function doTestsForProject(create: (options: ProjectOptions) => Promise) { it("should add the files from tsconfig.json by default with the target in the tsconfig.json", async () => { - const fileSystem = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }); + const fileSystem = new InMemoryFileSystemHost(); fileSystem.writeFileSync("tsconfig.json", `{ "compilerOptions": { "rootDir": "test", "target": "ES5" }, "include": ["test"] }`); fileSystem.writeFileSync("/otherFile.ts", ""); fileSystem.writeFileSync("/test/file.ts", ""); fileSystem.writeFileSync("/test/test2/file2.ts", ""); - const project = await create({ tsConfigFilePath: "tsconfig.json", fileSystem }); + const project = await create({ + tsConfigFilePath: "tsconfig.json", + fileSystem, + skipLoadingLibFiles: true, + }); expect(project.getSourceFiles().map(s => s.fileName).sort()).to.deep.equal(["/test/file.ts", "/test/test2/file2.ts"].sort()); expect(project.getSourceFiles().map(s => s.languageVersion)).to.deep.equal([ts.ScriptTarget.ES5, ts.ScriptTarget.ES5]); }); it("should add the files from tsconfig.json by default and also take into account the passed in compiler options", async () => { - const fileSystem = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }); + const fileSystem = new InMemoryFileSystemHost(); fileSystem.writeFileSync("tsconfig.json", `{ "compilerOptions": { "target": "ES5" } }`); fileSystem.writeFileSync("/otherFile.ts", ""); fileSystem.writeFileSync("/test/file.ts", ""); fileSystem.writeFileSync("/test/test2/file2.ts", ""); - const project = await create({ tsConfigFilePath: "tsconfig.json", compilerOptions: { rootDir: "/test/test2" }, fileSystem }); + const project = await create({ + tsConfigFilePath: "tsconfig.json", + compilerOptions: { rootDir: "/test/test2" }, + fileSystem, + skipLoadingLibFiles: true, + }); expect(project.getSourceFiles().map(s => s.fileName).sort()).to.deep.equal(["/otherFile.ts", "/test/file.ts", "/test/test2/file2.ts"].sort()); }); it("should not add the files from tsconfig.json when specifying not to", async () => { - const fileSystem = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }); + const fileSystem = new InMemoryFileSystemHost(); fileSystem.writeFileSync("tsconfig.json", `{ "compilerOptions": { "rootDir": "test", "target": "ES5" } }`); fileSystem.writeFileSync("/test/file.ts", ""); fileSystem.writeFileSync("/test/test2/file2.ts", ""); - const project = await create({ tsConfigFilePath: "tsconfig.json", skipAddingFilesFromTsConfig: true, fileSystem }); + const project = await create({ + tsConfigFilePath: "tsconfig.json", + skipAddingFilesFromTsConfig: true, + fileSystem, + skipLoadingLibFiles: true, + }); expect(project.getSourceFiles().map(s => s.fileName).sort()).to.deep.equal([]); }); @@ -211,24 +225,56 @@ describe(nameof(Project), () => { describe(nameof(o => o.skipLoadingLibFiles), () => { it("should not skip loading lib files when empty", async () => { const project = await create({ useInMemoryFileSystem: true }); - const result = project.fileSystem.readDirSync("/node_modules/typescript/lib"); - expect(result.some(r => r.includes("lib.d.ts"))).to.be.true; + const sourceFile = project.createSourceFile("test.ts", "const t: String = '';"); + const program = project.createProgram(); + expect(ts.getPreEmitDiagnostics(program).length).to.equal(0); + + const typeChecker = program.getTypeChecker(); + const varDecl = (sourceFile.statements[0] as ts.VariableStatement).declarationList.declarations[0]; + const varDeclType = typeChecker.getTypeAtLocation(varDecl.type!); + const stringDec = varDeclType.getSymbol()!.declarations[0]; + expect(stringDec.getSourceFile().fileName).to.equal("/node_modules/typescript/lib/lib.es5.d.ts"); }); - it("should not skip loading lib files when true", async () => { + it("should skip loading lib files when true", async () => { const project = await create({ useInMemoryFileSystem: true, skipLoadingLibFiles: true }); - expect(project.fileSystem.directoryExistsSync("/node_modules")).to.be.false; + const sourceFile = project.createSourceFile("test.ts", "const t: String = '';"); + const program = project.createProgram(); + expect(ts.getPreEmitDiagnostics(program).length).to.equal(10); + + const typeChecker = program.getTypeChecker(); + const varDecl = (sourceFile.statements[0] as ts.VariableStatement).declarationList.declarations[0]; + const varDeclType = typeChecker.getTypeAtLocation(varDecl.type!); + expect(varDeclType.getSymbol()).to.be.undefined; }); - it("should throw when providing skipLoadingLibFiles without using n in-memory file system", async () => { + it("should throw when providing skipLoadingLibFiles and a libFolderPath", async () => { try { - await create({ skipLoadingLibFiles: true }); + await create({ skipLoadingLibFiles: true, libFolderPath: "" }); expect.fail("should have thrown"); } catch (err) { - expect(err.message).to.equal("The skipLoadingLibFiles option can only be true when useInMemoryFileSystem is true."); + expect(err.message).to.equal("Cannot set skipLoadingLibFiles to true when libFolderPath is provided."); } }); }); + + describe(nameof(o => o.libFolderPath), () => { + it("should support specifying a different folder for the lib files", async () => { + const fileSystem = new InMemoryFileSystemHost(); + for (const file of getLibFiles()) + fileSystem.writeFileSync(`/other/${file.fileName}`, file.text); + const project = await create({ fileSystem, libFolderPath: "/other" }); + const sourceFile = project.createSourceFile("test.ts", "const t: String = '';"); + const program = project.createProgram(); + expect(ts.getPreEmitDiagnostics(program).length).to.equal(0); + + const typeChecker = program.getTypeChecker(); + const varDecl = (sourceFile.statements[0] as ts.VariableStatement).declarationList.declarations[0]; + const varDeclType = typeChecker.getTypeAtLocation(varDecl.type!); + const stringDec = varDeclType.getSymbol()!.declarations[0]; + expect(stringDec.getSourceFile().fileName).to.equal("/other/lib.es5.d.ts"); + }); + }); } }); @@ -376,14 +422,14 @@ describe(nameof(Project), () => { }); it("should add the files from tsconfig.json", async () => { - const fileSystem = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }); + const fileSystem = new InMemoryFileSystemHost(); fileSystem.writeFileSync("tsconfig.json", `{ "compilerOptions": { "rootDir": "test", "target": "ES5" }, "include": ["test"], "exclude": ["/test/exclude"] }`); fileSystem.writeFileSync("/otherFile.ts", ""); fileSystem.writeFileSync("/test/file.ts", ""); fileSystem.writeFileSync("/test/test2/file2.ts", ""); fileSystem.writeFileSync("/test/exclude/file.ts", ""); - const project = await createProject({ fileSystem }); + const project = await createProject({ fileSystem, skipLoadingLibFiles: true }); expect(project.getSourceFiles()).to.deep.equal([]); const returnedFiles = await action(project, "tsconfig.json"); const expectedFiles = ["/test/file.ts", "/test/test2/file2.ts"].sort(); @@ -401,12 +447,12 @@ describe(nameof(Project), () => { function doTestsForMethod(action: (project: Project, globs: string | readonly string[]) => Promise) { it("should add the source files based on a file glob", async () => { - const fileSystem = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }); + const fileSystem = new InMemoryFileSystemHost(); fileSystem.writeFileSync("/otherFile.ts", ""); fileSystem.writeFileSync("/test/file.ts", ""); fileSystem.writeFileSync("/test/test2/file2.ts", ""); fileSystem.writeFileSync("/test/other/file.ts", ""); - const project = await createProject({ fileSystem }); + const project = await createProject({ fileSystem, skipLoadingLibFiles: true }); expect(project.getSourceFiles()).to.deep.equal([]); const returnedFiles = await action(project, "/test/**/*.ts"); const expectedFiles = ["/test/file.ts", "/test/test2/file2.ts", "/test/other/file.ts"].sort(); @@ -427,7 +473,7 @@ describe(nameof(Project), () => { }); async function fileDependencyResolutionSetup(options: ProjectOptions = {}, create: (options: ProjectOptions) => Promise) { - const fileSystem = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }); + const fileSystem = new InMemoryFileSystemHost(); fileSystem.writeFileSync("/package.json", `{ "name": "testing", "version": "0.0.1" }`); fileSystem.writeFileSync("/node_modules/library/package.json", @@ -443,7 +489,7 @@ describe(nameof(Project), () => { fileSystem.writeFileSync("/other/referenced-file.d.ts", "declare function nameof(): void;"); fileSystem.writeFileSync("/tsconfig.json", `{ "files": ["src/main.ts"] }`); - const project = await create({ tsConfigFilePath: "tsconfig.json", fileSystem, ...options }); + const project = await create({ tsConfigFilePath: "tsconfig.json", fileSystem, ...options, skipLoadingLibFiles: true }); return { project, initialFiles: ["/src/main.ts"], @@ -560,7 +606,6 @@ describe(nameof(Project), () => { expect(moduleResolutionHost.getDirectories!("/")).to.deep.equal([ "/dir1", "/dir2", - "/node_modules", ]); }); @@ -573,7 +618,6 @@ describe(nameof(Project), () => { "/dir1", "/dir2", "/dir3", - "/node_modules", ]); }); diff --git a/packages/common/lib/ts-morph-common.d.ts b/packages/common/lib/ts-morph-common.d.ts index 5c48b7e8a..1288cd086 100644 --- a/packages/common/lib/ts-morph-common.d.ts +++ b/packages/common/lib/ts-morph-common.d.ts @@ -1,4 +1,4 @@ -import * as ts from "typescript"; +import * as ts from "./typescript"; export interface CompilerOptionsFromTsConfigOptions { encoding?: string; @@ -193,6 +193,16 @@ export interface CreateHostsOptions { * changed. Provide this for a performance improvement. */ getProjectVersion?: () => string; isKnownTypesPackageName?: ts.LanguageServiceHost["isKnownTypesPackageName"]; + /** + * Set this to true to not load the typescript lib files. + * @default false + */ + skipLoadingLibFiles?: boolean; + /** + * Specify this to use a custom folder to load the lib files from. + * @remarks skipLoadingLibFiles cannot be explicitly false if this is set. + */ + libFolderPath?: string; } /** @@ -255,7 +265,7 @@ export declare class DocumentRegistry implements ts.DocumentRegistry { /** @inheritdoc */ reportStats(): string; /** @inheritdoc */ - getSourceFileVersion(sourceFile: ts.SourceFile): any; + getSourceFileVersion(sourceFile: ts.SourceFile): string; private getNextSourceFileVersion; private updateSourceFile; } @@ -309,6 +319,12 @@ export interface TsSourceFileContainer { markInProject: boolean; scriptKind: ScriptKind | undefined; }): ts.SourceFile | undefined; + /** + * Adds a lib file whose existence is virtual to the cache. + * @param filePath - File path to get. + * @param scriptKind - Script kind of the source file. + */ + addLibFileToCacheByText(filePath: StandardizedFilePath, fileText: string, scriptKind: ScriptKind | undefined): ts.SourceFile; /** * Gets the source file version of the specified source file. * @param sourceFile - Source file to inspect. @@ -615,21 +631,12 @@ export declare class FileUtils { static isNegatedGlob(glob: string): boolean; } -export interface InMemoryFileSystemHostOptions { - /** - * Set this to true to not load the /node_modules/typescript/lib files on construction. - * @default false - */ - skipLoadingLibFiles?: boolean; -} - /** An implementation of a file system that exists in memory only. */ export declare class InMemoryFileSystemHost implements FileSystemHost { /** * Constructor. - * @param options - Options for creating the file system. */ - constructor(options?: InMemoryFileSystemHostOptions); + constructor(); /** @inheritdoc */ isCaseSensitive(): boolean; /** @inheritdoc */ @@ -988,5 +995,5 @@ export declare class StringUtils { }): string; } -import { CompilerOptions, DiagnosticCategory, EditorSettings, EmitHint, LanguageVariant, ModuleKind, ModuleResolutionKind, NewLineKind, NodeFlags, ObjectFlags, ScriptKind, ScriptTarget, SymbolFlags, SyntaxKind, TypeFlags, TypeFormatFlags } from "typescript"; +import { CompilerOptions, DiagnosticCategory, EditorSettings, EmitHint, LanguageVariant, ModuleKind, ModuleResolutionKind, NewLineKind, NodeFlags, ObjectFlags, ScriptKind, ScriptTarget, SymbolFlags, SyntaxKind, TypeFlags, TypeFormatFlags } from "./typescript"; export { ts, CompilerOptions, DiagnosticCategory, EditorSettings, EmitHint, LanguageVariant, ModuleKind, ModuleResolutionKind, NewLineKind, NodeFlags, ObjectFlags, ScriptKind, ScriptTarget, SymbolFlags, SyntaxKind, TypeFlags, TypeFormatFlags }; diff --git a/packages/common/lib/typescript.d.ts b/packages/common/lib/typescript.d.ts new file mode 100644 index 000000000..7c6c6301d --- /dev/null +++ b/packages/common/lib/typescript.d.ts @@ -0,0 +1,7204 @@ +/*! ***************************************************************************** +Copyright (c) Microsoft Corporation. All rights reserved. +Licensed under the Apache License, Version 2.0 (the "License"); you may not use +this file except in compliance with the License. You may obtain a copy of the +License at http://www.apache.org/licenses/LICENSE-2.0 + +THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED +WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE, +MERCHANTABLITY OR NON-INFRINGEMENT. + +See the Apache Version 2.0 License for specific language governing permissions +and limitations under the License. +***************************************************************************** */ + +declare namespace ts { + const versionMajorMinor = "4.1"; + /** The version of the TypeScript compiler release */ + const version: string; + /** + * Type of objects whose values are all of the same type. + * The `in` and `for-in` operators can *not* be safely used, + * since `Object.prototype` may be modified by outside code. + */ + interface MapLike { + [index: string]: T; + } + interface SortedReadonlyArray extends ReadonlyArray { + " __sortedArrayBrand": any; + } + interface SortedArray extends Array { + " __sortedArrayBrand": any; + } + /** Common read methods for ES6 Map/Set. */ + interface ReadonlyCollection { + readonly size: number; + has(key: K): boolean; + keys(): Iterator; + } + /** Common write methods for ES6 Map/Set. */ + interface Collection extends ReadonlyCollection { + delete(key: K): boolean; + clear(): void; + } + /** ES6 Map interface, only read methods included. */ + interface ReadonlyESMap extends ReadonlyCollection { + get(key: K): V | undefined; + values(): Iterator; + entries(): Iterator<[K, V]>; + forEach(action: (value: V, key: K) => void): void; + } + /** + * ES6 Map interface, only read methods included. + */ + interface ReadonlyMap extends ReadonlyESMap { + } + /** ES6 Map interface. */ + interface ESMap extends ReadonlyESMap, Collection { + set(key: K, value: V): this; + } + /** + * ES6 Map interface. + */ + interface Map extends ESMap { + } + /** ES6 Set interface, only read methods included. */ + interface ReadonlySet extends ReadonlyCollection { + has(value: T): boolean; + values(): Iterator; + entries(): Iterator<[T, T]>; + forEach(action: (value: T, key: T) => void): void; + } + /** ES6 Set interface. */ + interface Set extends ReadonlySet, Collection { + add(value: T): this; + delete(value: T): boolean; + } + /** ES6 Iterator type. */ + interface Iterator { + next(): { + value: T; + done?: false; + } | { + value: never; + done: true; + }; + } + /** Array that is only intended to be pushed to, never read. */ + interface Push { + push(...values: T[]): void; + } +} +declare namespace ts { + export type Path = string & { + __pathBrand: any; + }; + export interface TextRange { + pos: number; + end: number; + } + export interface ReadonlyTextRange { + readonly pos: number; + readonly end: number; + } + export enum SyntaxKind { + Unknown = 0, + EndOfFileToken = 1, + SingleLineCommentTrivia = 2, + MultiLineCommentTrivia = 3, + NewLineTrivia = 4, + WhitespaceTrivia = 5, + ShebangTrivia = 6, + ConflictMarkerTrivia = 7, + NumericLiteral = 8, + BigIntLiteral = 9, + StringLiteral = 10, + JsxText = 11, + JsxTextAllWhiteSpaces = 12, + RegularExpressionLiteral = 13, + NoSubstitutionTemplateLiteral = 14, + TemplateHead = 15, + TemplateMiddle = 16, + TemplateTail = 17, + OpenBraceToken = 18, + CloseBraceToken = 19, + OpenParenToken = 20, + CloseParenToken = 21, + OpenBracketToken = 22, + CloseBracketToken = 23, + DotToken = 24, + DotDotDotToken = 25, + SemicolonToken = 26, + CommaToken = 27, + QuestionDotToken = 28, + LessThanToken = 29, + LessThanSlashToken = 30, + GreaterThanToken = 31, + LessThanEqualsToken = 32, + GreaterThanEqualsToken = 33, + EqualsEqualsToken = 34, + ExclamationEqualsToken = 35, + EqualsEqualsEqualsToken = 36, + ExclamationEqualsEqualsToken = 37, + EqualsGreaterThanToken = 38, + PlusToken = 39, + MinusToken = 40, + AsteriskToken = 41, + AsteriskAsteriskToken = 42, + SlashToken = 43, + PercentToken = 44, + PlusPlusToken = 45, + MinusMinusToken = 46, + LessThanLessThanToken = 47, + GreaterThanGreaterThanToken = 48, + GreaterThanGreaterThanGreaterThanToken = 49, + AmpersandToken = 50, + BarToken = 51, + CaretToken = 52, + ExclamationToken = 53, + TildeToken = 54, + AmpersandAmpersandToken = 55, + BarBarToken = 56, + QuestionToken = 57, + ColonToken = 58, + AtToken = 59, + QuestionQuestionToken = 60, + /** Only the JSDoc scanner produces BacktickToken. The normal scanner produces NoSubstitutionTemplateLiteral and related kinds. */ + BacktickToken = 61, + EqualsToken = 62, + PlusEqualsToken = 63, + MinusEqualsToken = 64, + AsteriskEqualsToken = 65, + AsteriskAsteriskEqualsToken = 66, + SlashEqualsToken = 67, + PercentEqualsToken = 68, + LessThanLessThanEqualsToken = 69, + GreaterThanGreaterThanEqualsToken = 70, + GreaterThanGreaterThanGreaterThanEqualsToken = 71, + AmpersandEqualsToken = 72, + BarEqualsToken = 73, + BarBarEqualsToken = 74, + AmpersandAmpersandEqualsToken = 75, + QuestionQuestionEqualsToken = 76, + CaretEqualsToken = 77, + Identifier = 78, + PrivateIdentifier = 79, + BreakKeyword = 80, + CaseKeyword = 81, + CatchKeyword = 82, + ClassKeyword = 83, + ConstKeyword = 84, + ContinueKeyword = 85, + DebuggerKeyword = 86, + DefaultKeyword = 87, + DeleteKeyword = 88, + DoKeyword = 89, + ElseKeyword = 90, + EnumKeyword = 91, + ExportKeyword = 92, + ExtendsKeyword = 93, + FalseKeyword = 94, + FinallyKeyword = 95, + ForKeyword = 96, + FunctionKeyword = 97, + IfKeyword = 98, + ImportKeyword = 99, + InKeyword = 100, + InstanceOfKeyword = 101, + NewKeyword = 102, + NullKeyword = 103, + ReturnKeyword = 104, + SuperKeyword = 105, + SwitchKeyword = 106, + ThisKeyword = 107, + ThrowKeyword = 108, + TrueKeyword = 109, + TryKeyword = 110, + TypeOfKeyword = 111, + VarKeyword = 112, + VoidKeyword = 113, + WhileKeyword = 114, + WithKeyword = 115, + ImplementsKeyword = 116, + InterfaceKeyword = 117, + LetKeyword = 118, + PackageKeyword = 119, + PrivateKeyword = 120, + ProtectedKeyword = 121, + PublicKeyword = 122, + StaticKeyword = 123, + YieldKeyword = 124, + AbstractKeyword = 125, + AsKeyword = 126, + AssertsKeyword = 127, + AnyKeyword = 128, + AsyncKeyword = 129, + AwaitKeyword = 130, + BooleanKeyword = 131, + ConstructorKeyword = 132, + DeclareKeyword = 133, + GetKeyword = 134, + InferKeyword = 135, + IntrinsicKeyword = 136, + IsKeyword = 137, + KeyOfKeyword = 138, + ModuleKeyword = 139, + NamespaceKeyword = 140, + NeverKeyword = 141, + ReadonlyKeyword = 142, + RequireKeyword = 143, + NumberKeyword = 144, + ObjectKeyword = 145, + SetKeyword = 146, + StringKeyword = 147, + SymbolKeyword = 148, + TypeKeyword = 149, + UndefinedKeyword = 150, + UniqueKeyword = 151, + UnknownKeyword = 152, + FromKeyword = 153, + GlobalKeyword = 154, + BigIntKeyword = 155, + OfKeyword = 156, + QualifiedName = 157, + ComputedPropertyName = 158, + TypeParameter = 159, + Parameter = 160, + Decorator = 161, + PropertySignature = 162, + PropertyDeclaration = 163, + MethodSignature = 164, + MethodDeclaration = 165, + Constructor = 166, + GetAccessor = 167, + SetAccessor = 168, + CallSignature = 169, + ConstructSignature = 170, + IndexSignature = 171, + TypePredicate = 172, + TypeReference = 173, + FunctionType = 174, + ConstructorType = 175, + TypeQuery = 176, + TypeLiteral = 177, + ArrayType = 178, + TupleType = 179, + OptionalType = 180, + RestType = 181, + UnionType = 182, + IntersectionType = 183, + ConditionalType = 184, + InferType = 185, + ParenthesizedType = 186, + ThisType = 187, + TypeOperator = 188, + IndexedAccessType = 189, + MappedType = 190, + LiteralType = 191, + NamedTupleMember = 192, + TemplateLiteralType = 193, + TemplateLiteralTypeSpan = 194, + ImportType = 195, + ObjectBindingPattern = 196, + ArrayBindingPattern = 197, + BindingElement = 198, + ArrayLiteralExpression = 199, + ObjectLiteralExpression = 200, + PropertyAccessExpression = 201, + ElementAccessExpression = 202, + CallExpression = 203, + NewExpression = 204, + TaggedTemplateExpression = 205, + TypeAssertionExpression = 206, + ParenthesizedExpression = 207, + FunctionExpression = 208, + ArrowFunction = 209, + DeleteExpression = 210, + TypeOfExpression = 211, + VoidExpression = 212, + AwaitExpression = 213, + PrefixUnaryExpression = 214, + PostfixUnaryExpression = 215, + BinaryExpression = 216, + ConditionalExpression = 217, + TemplateExpression = 218, + YieldExpression = 219, + SpreadElement = 220, + ClassExpression = 221, + OmittedExpression = 222, + ExpressionWithTypeArguments = 223, + AsExpression = 224, + NonNullExpression = 225, + MetaProperty = 226, + SyntheticExpression = 227, + TemplateSpan = 228, + SemicolonClassElement = 229, + Block = 230, + EmptyStatement = 231, + VariableStatement = 232, + ExpressionStatement = 233, + IfStatement = 234, + DoStatement = 235, + WhileStatement = 236, + ForStatement = 237, + ForInStatement = 238, + ForOfStatement = 239, + ContinueStatement = 240, + BreakStatement = 241, + ReturnStatement = 242, + WithStatement = 243, + SwitchStatement = 244, + LabeledStatement = 245, + ThrowStatement = 246, + TryStatement = 247, + DebuggerStatement = 248, + VariableDeclaration = 249, + VariableDeclarationList = 250, + FunctionDeclaration = 251, + ClassDeclaration = 252, + InterfaceDeclaration = 253, + TypeAliasDeclaration = 254, + EnumDeclaration = 255, + ModuleDeclaration = 256, + ModuleBlock = 257, + CaseBlock = 258, + NamespaceExportDeclaration = 259, + ImportEqualsDeclaration = 260, + ImportDeclaration = 261, + ImportClause = 262, + NamespaceImport = 263, + NamedImports = 264, + ImportSpecifier = 265, + ExportAssignment = 266, + ExportDeclaration = 267, + NamedExports = 268, + NamespaceExport = 269, + ExportSpecifier = 270, + MissingDeclaration = 271, + ExternalModuleReference = 272, + JsxElement = 273, + JsxSelfClosingElement = 274, + JsxOpeningElement = 275, + JsxClosingElement = 276, + JsxFragment = 277, + JsxOpeningFragment = 278, + JsxClosingFragment = 279, + JsxAttribute = 280, + JsxAttributes = 281, + JsxSpreadAttribute = 282, + JsxExpression = 283, + CaseClause = 284, + DefaultClause = 285, + HeritageClause = 286, + CatchClause = 287, + PropertyAssignment = 288, + ShorthandPropertyAssignment = 289, + SpreadAssignment = 290, + EnumMember = 291, + UnparsedPrologue = 292, + UnparsedPrepend = 293, + UnparsedText = 294, + UnparsedInternalText = 295, + UnparsedSyntheticReference = 296, + SourceFile = 297, + Bundle = 298, + UnparsedSource = 299, + InputFiles = 300, + JSDocTypeExpression = 301, + JSDocNameReference = 302, + JSDocAllType = 303, + JSDocUnknownType = 304, + JSDocNullableType = 305, + JSDocNonNullableType = 306, + JSDocOptionalType = 307, + JSDocFunctionType = 308, + JSDocVariadicType = 309, + JSDocNamepathType = 310, + JSDocComment = 311, + JSDocTypeLiteral = 312, + JSDocSignature = 313, + JSDocTag = 314, + JSDocAugmentsTag = 315, + JSDocImplementsTag = 316, + JSDocAuthorTag = 317, + JSDocDeprecatedTag = 318, + JSDocClassTag = 319, + JSDocPublicTag = 320, + JSDocPrivateTag = 321, + JSDocProtectedTag = 322, + JSDocReadonlyTag = 323, + JSDocCallbackTag = 324, + JSDocEnumTag = 325, + JSDocParameterTag = 326, + JSDocReturnTag = 327, + JSDocThisTag = 328, + JSDocTypeTag = 329, + JSDocTemplateTag = 330, + JSDocTypedefTag = 331, + JSDocSeeTag = 332, + JSDocPropertyTag = 333, + SyntaxList = 334, + NotEmittedStatement = 335, + PartiallyEmittedExpression = 336, + CommaListExpression = 337, + MergeDeclarationMarker = 338, + EndOfDeclarationMarker = 339, + SyntheticReferenceExpression = 340, + Count = 341, + FirstAssignment = 62, + LastAssignment = 77, + FirstCompoundAssignment = 63, + LastCompoundAssignment = 77, + FirstReservedWord = 80, + LastReservedWord = 115, + FirstKeyword = 80, + LastKeyword = 156, + FirstFutureReservedWord = 116, + LastFutureReservedWord = 124, + FirstTypeNode = 172, + LastTypeNode = 195, + FirstPunctuation = 18, + LastPunctuation = 77, + FirstToken = 0, + LastToken = 156, + FirstTriviaToken = 2, + LastTriviaToken = 7, + FirstLiteralToken = 8, + LastLiteralToken = 14, + FirstTemplateToken = 14, + LastTemplateToken = 17, + FirstBinaryOperator = 29, + LastBinaryOperator = 77, + FirstStatement = 232, + LastStatement = 248, + FirstNode = 157, + FirstJSDocNode = 301, + LastJSDocNode = 333, + FirstJSDocTagNode = 314, + LastJSDocTagNode = 333, + } + export type TriviaSyntaxKind = SyntaxKind.SingleLineCommentTrivia | SyntaxKind.MultiLineCommentTrivia | SyntaxKind.NewLineTrivia | SyntaxKind.WhitespaceTrivia | SyntaxKind.ShebangTrivia | SyntaxKind.ConflictMarkerTrivia; + export type LiteralSyntaxKind = SyntaxKind.NumericLiteral | SyntaxKind.BigIntLiteral | SyntaxKind.StringLiteral | SyntaxKind.JsxText | SyntaxKind.JsxTextAllWhiteSpaces | SyntaxKind.RegularExpressionLiteral | SyntaxKind.NoSubstitutionTemplateLiteral; + export type PseudoLiteralSyntaxKind = SyntaxKind.TemplateHead | SyntaxKind.TemplateMiddle | SyntaxKind.TemplateTail; + export type PunctuationSyntaxKind = SyntaxKind.OpenBraceToken | SyntaxKind.CloseBraceToken | SyntaxKind.OpenParenToken | SyntaxKind.CloseParenToken | SyntaxKind.OpenBracketToken | SyntaxKind.CloseBracketToken | SyntaxKind.DotToken | SyntaxKind.DotDotDotToken | SyntaxKind.SemicolonToken | SyntaxKind.CommaToken | SyntaxKind.QuestionDotToken | SyntaxKind.LessThanToken | SyntaxKind.LessThanSlashToken | SyntaxKind.GreaterThanToken | SyntaxKind.LessThanEqualsToken | SyntaxKind.GreaterThanEqualsToken | SyntaxKind.EqualsEqualsToken | SyntaxKind.ExclamationEqualsToken | SyntaxKind.EqualsEqualsEqualsToken | SyntaxKind.ExclamationEqualsEqualsToken | SyntaxKind.EqualsGreaterThanToken | SyntaxKind.PlusToken | SyntaxKind.MinusToken | SyntaxKind.AsteriskToken | SyntaxKind.AsteriskAsteriskToken | SyntaxKind.SlashToken | SyntaxKind.PercentToken | SyntaxKind.PlusPlusToken | SyntaxKind.MinusMinusToken | SyntaxKind.LessThanLessThanToken | SyntaxKind.GreaterThanGreaterThanToken | SyntaxKind.GreaterThanGreaterThanGreaterThanToken | SyntaxKind.AmpersandToken | SyntaxKind.BarToken | SyntaxKind.CaretToken | SyntaxKind.ExclamationToken | SyntaxKind.TildeToken | SyntaxKind.AmpersandAmpersandToken | SyntaxKind.BarBarToken | SyntaxKind.QuestionQuestionToken | SyntaxKind.QuestionToken | SyntaxKind.ColonToken | SyntaxKind.AtToken | SyntaxKind.BacktickToken | SyntaxKind.EqualsToken | SyntaxKind.PlusEqualsToken | SyntaxKind.MinusEqualsToken | SyntaxKind.AsteriskEqualsToken | SyntaxKind.AsteriskAsteriskEqualsToken | SyntaxKind.SlashEqualsToken | SyntaxKind.PercentEqualsToken | SyntaxKind.LessThanLessThanEqualsToken | SyntaxKind.GreaterThanGreaterThanEqualsToken | SyntaxKind.GreaterThanGreaterThanGreaterThanEqualsToken | SyntaxKind.AmpersandEqualsToken | SyntaxKind.BarEqualsToken | SyntaxKind.CaretEqualsToken; + export type KeywordSyntaxKind = SyntaxKind.AbstractKeyword | SyntaxKind.AnyKeyword | SyntaxKind.AsKeyword | SyntaxKind.AssertsKeyword | SyntaxKind.AsyncKeyword | SyntaxKind.AwaitKeyword | SyntaxKind.BigIntKeyword | SyntaxKind.BooleanKeyword | SyntaxKind.BreakKeyword | SyntaxKind.CaseKeyword | SyntaxKind.CatchKeyword | SyntaxKind.ClassKeyword | SyntaxKind.ConstKeyword | SyntaxKind.ConstructorKeyword | SyntaxKind.ContinueKeyword | SyntaxKind.DebuggerKeyword | SyntaxKind.DeclareKeyword | SyntaxKind.DefaultKeyword | SyntaxKind.DeleteKeyword | SyntaxKind.DoKeyword | SyntaxKind.ElseKeyword | SyntaxKind.EnumKeyword | SyntaxKind.ExportKeyword | SyntaxKind.ExtendsKeyword | SyntaxKind.FalseKeyword | SyntaxKind.FinallyKeyword | SyntaxKind.ForKeyword | SyntaxKind.FromKeyword | SyntaxKind.FunctionKeyword | SyntaxKind.GetKeyword | SyntaxKind.GlobalKeyword | SyntaxKind.IfKeyword | SyntaxKind.ImplementsKeyword | SyntaxKind.ImportKeyword | SyntaxKind.InferKeyword | SyntaxKind.InKeyword | SyntaxKind.InstanceOfKeyword | SyntaxKind.InterfaceKeyword | SyntaxKind.IntrinsicKeyword | SyntaxKind.IsKeyword | SyntaxKind.KeyOfKeyword | SyntaxKind.LetKeyword | SyntaxKind.ModuleKeyword | SyntaxKind.NamespaceKeyword | SyntaxKind.NeverKeyword | SyntaxKind.NewKeyword | SyntaxKind.NullKeyword | SyntaxKind.NumberKeyword | SyntaxKind.ObjectKeyword | SyntaxKind.OfKeyword | SyntaxKind.PackageKeyword | SyntaxKind.PrivateKeyword | SyntaxKind.ProtectedKeyword | SyntaxKind.PublicKeyword | SyntaxKind.ReadonlyKeyword | SyntaxKind.RequireKeyword | SyntaxKind.ReturnKeyword | SyntaxKind.SetKeyword | SyntaxKind.StaticKeyword | SyntaxKind.StringKeyword | SyntaxKind.SuperKeyword | SyntaxKind.SwitchKeyword | SyntaxKind.SymbolKeyword | SyntaxKind.ThisKeyword | SyntaxKind.ThrowKeyword | SyntaxKind.TrueKeyword | SyntaxKind.TryKeyword | SyntaxKind.TypeKeyword | SyntaxKind.TypeOfKeyword | SyntaxKind.UndefinedKeyword | SyntaxKind.UniqueKeyword | SyntaxKind.UnknownKeyword | SyntaxKind.VarKeyword | SyntaxKind.VoidKeyword | SyntaxKind.WhileKeyword | SyntaxKind.WithKeyword | SyntaxKind.YieldKeyword; + export type ModifierSyntaxKind = SyntaxKind.AbstractKeyword | SyntaxKind.AsyncKeyword | SyntaxKind.ConstKeyword | SyntaxKind.DeclareKeyword | SyntaxKind.DefaultKeyword | SyntaxKind.ExportKeyword | SyntaxKind.PrivateKeyword | SyntaxKind.ProtectedKeyword | SyntaxKind.PublicKeyword | SyntaxKind.ReadonlyKeyword | SyntaxKind.StaticKeyword; + export type KeywordTypeSyntaxKind = SyntaxKind.AnyKeyword | SyntaxKind.BigIntKeyword | SyntaxKind.BooleanKeyword | SyntaxKind.IntrinsicKeyword | SyntaxKind.NeverKeyword | SyntaxKind.NumberKeyword | SyntaxKind.ObjectKeyword | SyntaxKind.StringKeyword | SyntaxKind.SymbolKeyword | SyntaxKind.UndefinedKeyword | SyntaxKind.UnknownKeyword | SyntaxKind.VoidKeyword; + export type TokenSyntaxKind = SyntaxKind.Unknown | SyntaxKind.EndOfFileToken | TriviaSyntaxKind | LiteralSyntaxKind | PseudoLiteralSyntaxKind | PunctuationSyntaxKind | SyntaxKind.Identifier | KeywordSyntaxKind; + export type JsxTokenSyntaxKind = SyntaxKind.LessThanSlashToken | SyntaxKind.EndOfFileToken | SyntaxKind.ConflictMarkerTrivia | SyntaxKind.JsxText | SyntaxKind.JsxTextAllWhiteSpaces | SyntaxKind.OpenBraceToken | SyntaxKind.LessThanToken; + export type JSDocSyntaxKind = SyntaxKind.EndOfFileToken | SyntaxKind.WhitespaceTrivia | SyntaxKind.AtToken | SyntaxKind.NewLineTrivia | SyntaxKind.AsteriskToken | SyntaxKind.OpenBraceToken | SyntaxKind.CloseBraceToken | SyntaxKind.LessThanToken | SyntaxKind.GreaterThanToken | SyntaxKind.OpenBracketToken | SyntaxKind.CloseBracketToken | SyntaxKind.EqualsToken | SyntaxKind.CommaToken | SyntaxKind.DotToken | SyntaxKind.Identifier | SyntaxKind.BacktickToken | SyntaxKind.Unknown | KeywordSyntaxKind; + export enum NodeFlags { + None = 0, + Let = 1, + Const = 2, + NestedNamespace = 4, + Synthesized = 8, + Namespace = 16, + OptionalChain = 32, + ExportContext = 64, + ContainsThis = 128, + HasImplicitReturn = 256, + HasExplicitReturn = 512, + GlobalAugmentation = 1024, + HasAsyncFunctions = 2048, + DisallowInContext = 4096, + YieldContext = 8192, + DecoratorContext = 16384, + AwaitContext = 32768, + ThisNodeHasError = 65536, + JavaScriptFile = 131072, + ThisNodeOrAnySubNodesHasError = 262144, + HasAggregatedChildData = 524288, + JSDoc = 4194304, + JsonFile = 33554432, + BlockScoped = 3, + ReachabilityCheckFlags = 768, + ReachabilityAndEmitFlags = 2816, + ContextFlags = 25358336, + TypeExcludesFlags = 40960, + } + export enum ModifierFlags { + None = 0, + Export = 1, + Ambient = 2, + Public = 4, + Private = 8, + Protected = 16, + Static = 32, + Readonly = 64, + Abstract = 128, + Async = 256, + Default = 512, + Const = 2048, + HasComputedJSDocModifiers = 4096, + Deprecated = 8192, + HasComputedFlags = 536870912, + AccessibilityModifier = 28, + ParameterPropertyModifier = 92, + NonPublicAccessibilityModifier = 24, + TypeScriptModifier = 2270, + ExportDefault = 513, + All = 11263 + } + export enum JsxFlags { + None = 0, + /** An element from a named property of the JSX.IntrinsicElements interface */ + IntrinsicNamedElement = 1, + /** An element inferred from the string index signature of the JSX.IntrinsicElements interface */ + IntrinsicIndexedElement = 2, + IntrinsicElement = 3 + } + export interface Node extends ReadonlyTextRange { + readonly kind: SyntaxKind; + readonly flags: NodeFlags; + readonly decorators?: NodeArray; + readonly modifiers?: ModifiersArray; + readonly parent: Node; + } + export interface JSDocContainer { + } + export type HasJSDoc = ParameterDeclaration | CallSignatureDeclaration | ConstructSignatureDeclaration | MethodSignature | PropertySignature | ArrowFunction | ParenthesizedExpression | SpreadAssignment | ShorthandPropertyAssignment | PropertyAssignment | FunctionExpression | LabeledStatement | ExpressionStatement | VariableStatement | FunctionDeclaration | ConstructorDeclaration | MethodDeclaration | PropertyDeclaration | AccessorDeclaration | ClassLikeDeclaration | InterfaceDeclaration | TypeAliasDeclaration | EnumMember | EnumDeclaration | ModuleDeclaration | ImportEqualsDeclaration | ImportDeclaration | NamespaceExportDeclaration | ExportAssignment | IndexSignatureDeclaration | FunctionTypeNode | ConstructorTypeNode | JSDocFunctionType | ExportDeclaration | NamedTupleMember | EndOfFileToken; + export type HasType = SignatureDeclaration | VariableDeclaration | ParameterDeclaration | PropertySignature | PropertyDeclaration | TypePredicateNode | ParenthesizedTypeNode | TypeOperatorNode | MappedTypeNode | AssertionExpression | TypeAliasDeclaration | JSDocTypeExpression | JSDocNonNullableType | JSDocNullableType | JSDocOptionalType | JSDocVariadicType; + export type HasTypeArguments = CallExpression | NewExpression | TaggedTemplateExpression | JsxOpeningElement | JsxSelfClosingElement; + export type HasInitializer = HasExpressionInitializer | ForStatement | ForInStatement | ForOfStatement | JsxAttribute; + export type HasExpressionInitializer = VariableDeclaration | ParameterDeclaration | BindingElement | PropertySignature | PropertyDeclaration | PropertyAssignment | EnumMember; + export interface NodeArray extends ReadonlyArray, ReadonlyTextRange { + hasTrailingComma?: boolean; + } + export interface Token extends Node { + readonly kind: TKind; + } + export type EndOfFileToken = Token & JSDocContainer; + export interface PunctuationToken extends Token { + } + export type DotToken = PunctuationToken; + export type DotDotDotToken = PunctuationToken; + export type QuestionToken = PunctuationToken; + export type ExclamationToken = PunctuationToken; + export type ColonToken = PunctuationToken; + export type EqualsToken = PunctuationToken; + export type AsteriskToken = PunctuationToken; + export type EqualsGreaterThanToken = PunctuationToken; + export type PlusToken = PunctuationToken; + export type MinusToken = PunctuationToken; + export type QuestionDotToken = PunctuationToken; + export interface KeywordToken extends Token { + } + export type AssertsKeyword = KeywordToken; + export type AwaitKeyword = KeywordToken; + /** @deprecated Use `AwaitKeyword` instead. */ + export type AwaitKeywordToken = AwaitKeyword; + /** @deprecated Use `AssertsKeyword` instead. */ + export type AssertsToken = AssertsKeyword; + export interface ModifierToken extends KeywordToken { + } + export type AbstractKeyword = ModifierToken; + export type AsyncKeyword = ModifierToken; + export type ConstKeyword = ModifierToken; + export type DeclareKeyword = ModifierToken; + export type DefaultKeyword = ModifierToken; + export type ExportKeyword = ModifierToken; + export type PrivateKeyword = ModifierToken; + export type ProtectedKeyword = ModifierToken; + export type PublicKeyword = ModifierToken; + export type ReadonlyKeyword = ModifierToken; + export type StaticKeyword = ModifierToken; + /** @deprecated Use `ReadonlyKeyword` instead. */ + export type ReadonlyToken = ReadonlyKeyword; + export type Modifier = AbstractKeyword | AsyncKeyword | ConstKeyword | DeclareKeyword | DefaultKeyword | ExportKeyword | PrivateKeyword | ProtectedKeyword | PublicKeyword | ReadonlyKeyword | StaticKeyword; + export type AccessibilityModifier = PublicKeyword | PrivateKeyword | ProtectedKeyword; + export type ParameterPropertyModifier = AccessibilityModifier | ReadonlyKeyword; + export type ClassMemberModifier = AccessibilityModifier | ReadonlyKeyword | StaticKeyword; + export type ModifiersArray = NodeArray; + export enum GeneratedIdentifierFlags { + None = 0, + ReservedInNestedScopes = 8, + Optimistic = 16, + FileLevel = 32, + AllowNameSubstitution = 64 + } + export interface Identifier extends PrimaryExpression, Declaration { + readonly kind: SyntaxKind.Identifier; + /** + * Prefer to use `id.unescapedText`. (Note: This is available only in services, not internally to the TypeScript compiler.) + * Text of identifier, but if the identifier begins with two underscores, this will begin with three. + */ + readonly escapedText: __String; + readonly originalKeywordKind?: SyntaxKind; + isInJSDocNamespace?: boolean; + } + export interface TransientIdentifier extends Identifier { + resolvedSymbol: Symbol; + } + export interface QualifiedName extends Node { + readonly kind: SyntaxKind.QualifiedName; + readonly left: EntityName; + readonly right: Identifier; + } + export type EntityName = Identifier | QualifiedName; + export type PropertyName = Identifier | StringLiteral | NumericLiteral | ComputedPropertyName | PrivateIdentifier; + export type DeclarationName = Identifier | PrivateIdentifier | StringLiteralLike | NumericLiteral | ComputedPropertyName | ElementAccessExpression | BindingPattern | EntityNameExpression; + export interface Declaration extends Node { + _declarationBrand: any; + } + export interface NamedDeclaration extends Declaration { + readonly name?: DeclarationName; + } + export interface DeclarationStatement extends NamedDeclaration, Statement { + readonly name?: Identifier | StringLiteral | NumericLiteral; + } + export interface ComputedPropertyName extends Node { + readonly kind: SyntaxKind.ComputedPropertyName; + readonly parent: Declaration; + readonly expression: Expression; + } + export interface PrivateIdentifier extends Node { + readonly kind: SyntaxKind.PrivateIdentifier; + readonly escapedText: __String; + } + export interface Decorator extends Node { + readonly kind: SyntaxKind.Decorator; + readonly parent: NamedDeclaration; + readonly expression: LeftHandSideExpression; + } + export interface TypeParameterDeclaration extends NamedDeclaration { + readonly kind: SyntaxKind.TypeParameter; + readonly parent: DeclarationWithTypeParameterChildren | InferTypeNode; + readonly name: Identifier; + /** Note: Consider calling `getEffectiveConstraintOfTypeParameter` */ + readonly constraint?: TypeNode; + readonly default?: TypeNode; + expression?: Expression; + } + export interface SignatureDeclarationBase extends NamedDeclaration, JSDocContainer { + readonly kind: SignatureDeclaration["kind"]; + readonly name?: PropertyName; + readonly typeParameters?: NodeArray; + readonly parameters: NodeArray; + readonly type?: TypeNode; + } + export type SignatureDeclaration = CallSignatureDeclaration | ConstructSignatureDeclaration | MethodSignature | IndexSignatureDeclaration | FunctionTypeNode | ConstructorTypeNode | JSDocFunctionType | FunctionDeclaration | MethodDeclaration | ConstructorDeclaration | AccessorDeclaration | FunctionExpression | ArrowFunction; + export interface CallSignatureDeclaration extends SignatureDeclarationBase, TypeElement { + readonly kind: SyntaxKind.CallSignature; + } + export interface ConstructSignatureDeclaration extends SignatureDeclarationBase, TypeElement { + readonly kind: SyntaxKind.ConstructSignature; + } + export type BindingName = Identifier | BindingPattern; + export interface VariableDeclaration extends NamedDeclaration { + readonly kind: SyntaxKind.VariableDeclaration; + readonly parent: VariableDeclarationList | CatchClause; + readonly name: BindingName; + readonly exclamationToken?: ExclamationToken; + readonly type?: TypeNode; + readonly initializer?: Expression; + } + export interface VariableDeclarationList extends Node { + readonly kind: SyntaxKind.VariableDeclarationList; + readonly parent: VariableStatement | ForStatement | ForOfStatement | ForInStatement; + readonly declarations: NodeArray; + } + export interface ParameterDeclaration extends NamedDeclaration, JSDocContainer { + readonly kind: SyntaxKind.Parameter; + readonly parent: SignatureDeclaration; + readonly dotDotDotToken?: DotDotDotToken; + readonly name: BindingName; + readonly questionToken?: QuestionToken; + readonly type?: TypeNode; + readonly initializer?: Expression; + } + export interface BindingElement extends NamedDeclaration { + readonly kind: SyntaxKind.BindingElement; + readonly parent: BindingPattern; + readonly propertyName?: PropertyName; + readonly dotDotDotToken?: DotDotDotToken; + readonly name: BindingName; + readonly initializer?: Expression; + } + export interface PropertySignature extends TypeElement, JSDocContainer { + readonly kind: SyntaxKind.PropertySignature; + readonly name: PropertyName; + readonly questionToken?: QuestionToken; + readonly type?: TypeNode; + initializer?: Expression; + } + export interface PropertyDeclaration extends ClassElement, JSDocContainer { + readonly kind: SyntaxKind.PropertyDeclaration; + readonly parent: ClassLikeDeclaration; + readonly name: PropertyName; + readonly questionToken?: QuestionToken; + readonly exclamationToken?: ExclamationToken; + readonly type?: TypeNode; + readonly initializer?: Expression; + } + export interface ObjectLiteralElement extends NamedDeclaration { + _objectLiteralBrand: any; + readonly name?: PropertyName; + } + /** Unlike ObjectLiteralElement, excludes JSXAttribute and JSXSpreadAttribute. */ + export type ObjectLiteralElementLike = PropertyAssignment | ShorthandPropertyAssignment | SpreadAssignment | MethodDeclaration | AccessorDeclaration; + export interface PropertyAssignment extends ObjectLiteralElement, JSDocContainer { + readonly kind: SyntaxKind.PropertyAssignment; + readonly parent: ObjectLiteralExpression; + readonly name: PropertyName; + readonly questionToken?: QuestionToken; + readonly exclamationToken?: ExclamationToken; + readonly initializer: Expression; + } + export interface ShorthandPropertyAssignment extends ObjectLiteralElement, JSDocContainer { + readonly kind: SyntaxKind.ShorthandPropertyAssignment; + readonly parent: ObjectLiteralExpression; + readonly name: Identifier; + readonly questionToken?: QuestionToken; + readonly exclamationToken?: ExclamationToken; + readonly equalsToken?: EqualsToken; + readonly objectAssignmentInitializer?: Expression; + } + export interface SpreadAssignment extends ObjectLiteralElement, JSDocContainer { + readonly kind: SyntaxKind.SpreadAssignment; + readonly parent: ObjectLiteralExpression; + readonly expression: Expression; + } + export type VariableLikeDeclaration = VariableDeclaration | ParameterDeclaration | BindingElement | PropertyDeclaration | PropertyAssignment | PropertySignature | JsxAttribute | ShorthandPropertyAssignment | EnumMember | JSDocPropertyTag | JSDocParameterTag; + export interface PropertyLikeDeclaration extends NamedDeclaration { + readonly name: PropertyName; + } + export interface ObjectBindingPattern extends Node { + readonly kind: SyntaxKind.ObjectBindingPattern; + readonly parent: VariableDeclaration | ParameterDeclaration | BindingElement; + readonly elements: NodeArray; + } + export interface ArrayBindingPattern extends Node { + readonly kind: SyntaxKind.ArrayBindingPattern; + readonly parent: VariableDeclaration | ParameterDeclaration | BindingElement; + readonly elements: NodeArray; + } + export type BindingPattern = ObjectBindingPattern | ArrayBindingPattern; + export type ArrayBindingElement = BindingElement | OmittedExpression; + /** + * Several node kinds share function-like features such as a signature, + * a name, and a body. These nodes should extend FunctionLikeDeclarationBase. + * Examples: + * - FunctionDeclaration + * - MethodDeclaration + * - AccessorDeclaration + */ + export interface FunctionLikeDeclarationBase extends SignatureDeclarationBase { + _functionLikeDeclarationBrand: any; + readonly asteriskToken?: AsteriskToken; + readonly questionToken?: QuestionToken; + readonly exclamationToken?: ExclamationToken; + readonly body?: Block | Expression; + } + export type FunctionLikeDeclaration = FunctionDeclaration | MethodDeclaration | GetAccessorDeclaration | SetAccessorDeclaration | ConstructorDeclaration | FunctionExpression | ArrowFunction; + /** @deprecated Use SignatureDeclaration */ + export type FunctionLike = SignatureDeclaration; + export interface FunctionDeclaration extends FunctionLikeDeclarationBase, DeclarationStatement { + readonly kind: SyntaxKind.FunctionDeclaration; + readonly name?: Identifier; + readonly body?: FunctionBody; + } + export interface MethodSignature extends SignatureDeclarationBase, TypeElement { + readonly kind: SyntaxKind.MethodSignature; + readonly parent: ObjectTypeDeclaration; + readonly name: PropertyName; + } + export interface MethodDeclaration extends FunctionLikeDeclarationBase, ClassElement, ObjectLiteralElement, JSDocContainer { + readonly kind: SyntaxKind.MethodDeclaration; + readonly parent: ClassLikeDeclaration | ObjectLiteralExpression; + readonly name: PropertyName; + readonly body?: FunctionBody; + } + export interface ConstructorDeclaration extends FunctionLikeDeclarationBase, ClassElement, JSDocContainer { + readonly kind: SyntaxKind.Constructor; + readonly parent: ClassLikeDeclaration; + readonly body?: FunctionBody; + } + /** For when we encounter a semicolon in a class declaration. ES6 allows these as class elements. */ + export interface SemicolonClassElement extends ClassElement { + readonly kind: SyntaxKind.SemicolonClassElement; + readonly parent: ClassLikeDeclaration; + } + export interface GetAccessorDeclaration extends FunctionLikeDeclarationBase, ClassElement, ObjectLiteralElement, JSDocContainer { + readonly kind: SyntaxKind.GetAccessor; + readonly parent: ClassLikeDeclaration | ObjectLiteralExpression; + readonly name: PropertyName; + readonly body?: FunctionBody; + } + export interface SetAccessorDeclaration extends FunctionLikeDeclarationBase, ClassElement, ObjectLiteralElement, JSDocContainer { + readonly kind: SyntaxKind.SetAccessor; + readonly parent: ClassLikeDeclaration | ObjectLiteralExpression; + readonly name: PropertyName; + readonly body?: FunctionBody; + } + export type AccessorDeclaration = GetAccessorDeclaration | SetAccessorDeclaration; + export interface IndexSignatureDeclaration extends SignatureDeclarationBase, ClassElement, TypeElement { + readonly kind: SyntaxKind.IndexSignature; + readonly parent: ObjectTypeDeclaration; + readonly type: TypeNode; + } + export interface TypeNode extends Node { + _typeNodeBrand: any; + } + export interface KeywordTypeNode extends KeywordToken, TypeNode { + readonly kind: TKind; + } + export interface ImportTypeNode extends NodeWithTypeArguments { + readonly kind: SyntaxKind.ImportType; + readonly isTypeOf: boolean; + readonly argument: TypeNode; + readonly qualifier?: EntityName; + } + export interface ThisTypeNode extends TypeNode { + readonly kind: SyntaxKind.ThisType; + } + export type FunctionOrConstructorTypeNode = FunctionTypeNode | ConstructorTypeNode; + export interface FunctionOrConstructorTypeNodeBase extends TypeNode, SignatureDeclarationBase { + readonly kind: SyntaxKind.FunctionType | SyntaxKind.ConstructorType; + readonly type: TypeNode; + } + export interface FunctionTypeNode extends FunctionOrConstructorTypeNodeBase { + readonly kind: SyntaxKind.FunctionType; + } + export interface ConstructorTypeNode extends FunctionOrConstructorTypeNodeBase { + readonly kind: SyntaxKind.ConstructorType; + } + export interface NodeWithTypeArguments extends TypeNode { + readonly typeArguments?: NodeArray; + } + export type TypeReferenceType = TypeReferenceNode | ExpressionWithTypeArguments; + export interface TypeReferenceNode extends NodeWithTypeArguments { + readonly kind: SyntaxKind.TypeReference; + readonly typeName: EntityName; + } + export interface TypePredicateNode extends TypeNode { + readonly kind: SyntaxKind.TypePredicate; + readonly parent: SignatureDeclaration | JSDocTypeExpression; + readonly assertsModifier?: AssertsToken; + readonly parameterName: Identifier | ThisTypeNode; + readonly type?: TypeNode; + } + export interface TypeQueryNode extends TypeNode { + readonly kind: SyntaxKind.TypeQuery; + readonly exprName: EntityName; + } + export interface TypeLiteralNode extends TypeNode, Declaration { + readonly kind: SyntaxKind.TypeLiteral; + readonly members: NodeArray; + } + export interface ArrayTypeNode extends TypeNode { + readonly kind: SyntaxKind.ArrayType; + readonly elementType: TypeNode; + } + export interface TupleTypeNode extends TypeNode { + readonly kind: SyntaxKind.TupleType; + readonly elements: NodeArray; + } + export interface NamedTupleMember extends TypeNode, JSDocContainer, Declaration { + readonly kind: SyntaxKind.NamedTupleMember; + readonly dotDotDotToken?: Token; + readonly name: Identifier; + readonly questionToken?: Token; + readonly type: TypeNode; + } + export interface OptionalTypeNode extends TypeNode { + readonly kind: SyntaxKind.OptionalType; + readonly type: TypeNode; + } + export interface RestTypeNode extends TypeNode { + readonly kind: SyntaxKind.RestType; + readonly type: TypeNode; + } + export type UnionOrIntersectionTypeNode = UnionTypeNode | IntersectionTypeNode; + export interface UnionTypeNode extends TypeNode { + readonly kind: SyntaxKind.UnionType; + readonly types: NodeArray; + } + export interface IntersectionTypeNode extends TypeNode { + readonly kind: SyntaxKind.IntersectionType; + readonly types: NodeArray; + } + export interface ConditionalTypeNode extends TypeNode { + readonly kind: SyntaxKind.ConditionalType; + readonly checkType: TypeNode; + readonly extendsType: TypeNode; + readonly trueType: TypeNode; + readonly falseType: TypeNode; + } + export interface InferTypeNode extends TypeNode { + readonly kind: SyntaxKind.InferType; + readonly typeParameter: TypeParameterDeclaration; + } + export interface ParenthesizedTypeNode extends TypeNode { + readonly kind: SyntaxKind.ParenthesizedType; + readonly type: TypeNode; + } + export interface TypeOperatorNode extends TypeNode { + readonly kind: SyntaxKind.TypeOperator; + readonly operator: SyntaxKind.KeyOfKeyword | SyntaxKind.UniqueKeyword | SyntaxKind.ReadonlyKeyword; + readonly type: TypeNode; + } + export interface IndexedAccessTypeNode extends TypeNode { + readonly kind: SyntaxKind.IndexedAccessType; + readonly objectType: TypeNode; + readonly indexType: TypeNode; + } + export interface MappedTypeNode extends TypeNode, Declaration { + readonly kind: SyntaxKind.MappedType; + readonly readonlyToken?: ReadonlyToken | PlusToken | MinusToken; + readonly typeParameter: TypeParameterDeclaration; + readonly nameType?: TypeNode; + readonly questionToken?: QuestionToken | PlusToken | MinusToken; + readonly type?: TypeNode; + } + export interface LiteralTypeNode extends TypeNode { + readonly kind: SyntaxKind.LiteralType; + readonly literal: NullLiteral | BooleanLiteral | LiteralExpression | PrefixUnaryExpression; + } + export interface StringLiteral extends LiteralExpression, Declaration { + readonly kind: SyntaxKind.StringLiteral; + } + export type StringLiteralLike = StringLiteral | NoSubstitutionTemplateLiteral; + export type PropertyNameLiteral = Identifier | StringLiteralLike | NumericLiteral; + export interface TemplateLiteralTypeNode extends TypeNode { + kind: SyntaxKind.TemplateLiteralType; + readonly head: TemplateHead; + readonly templateSpans: NodeArray; + } + export interface TemplateLiteralTypeSpan extends TypeNode { + readonly kind: SyntaxKind.TemplateLiteralTypeSpan; + readonly parent: TemplateLiteralTypeNode; + readonly type: TypeNode; + readonly literal: TemplateMiddle | TemplateTail; + } + export interface Expression extends Node { + _expressionBrand: any; + } + export interface OmittedExpression extends Expression { + readonly kind: SyntaxKind.OmittedExpression; + } + export interface PartiallyEmittedExpression extends LeftHandSideExpression { + readonly kind: SyntaxKind.PartiallyEmittedExpression; + readonly expression: Expression; + } + export interface UnaryExpression extends Expression { + _unaryExpressionBrand: any; + } + /** Deprecated, please use UpdateExpression */ + export type IncrementExpression = UpdateExpression; + export interface UpdateExpression extends UnaryExpression { + _updateExpressionBrand: any; + } + export type PrefixUnaryOperator = SyntaxKind.PlusPlusToken | SyntaxKind.MinusMinusToken | SyntaxKind.PlusToken | SyntaxKind.MinusToken | SyntaxKind.TildeToken | SyntaxKind.ExclamationToken; + export interface PrefixUnaryExpression extends UpdateExpression { + readonly kind: SyntaxKind.PrefixUnaryExpression; + readonly operator: PrefixUnaryOperator; + readonly operand: UnaryExpression; + } + export type PostfixUnaryOperator = SyntaxKind.PlusPlusToken | SyntaxKind.MinusMinusToken; + export interface PostfixUnaryExpression extends UpdateExpression { + readonly kind: SyntaxKind.PostfixUnaryExpression; + readonly operand: LeftHandSideExpression; + readonly operator: PostfixUnaryOperator; + } + export interface LeftHandSideExpression extends UpdateExpression { + _leftHandSideExpressionBrand: any; + } + export interface MemberExpression extends LeftHandSideExpression { + _memberExpressionBrand: any; + } + export interface PrimaryExpression extends MemberExpression { + _primaryExpressionBrand: any; + } + export interface NullLiteral extends PrimaryExpression { + readonly kind: SyntaxKind.NullKeyword; + } + export interface TrueLiteral extends PrimaryExpression { + readonly kind: SyntaxKind.TrueKeyword; + } + export interface FalseLiteral extends PrimaryExpression { + readonly kind: SyntaxKind.FalseKeyword; + } + export type BooleanLiteral = TrueLiteral | FalseLiteral; + export interface ThisExpression extends PrimaryExpression { + readonly kind: SyntaxKind.ThisKeyword; + } + export interface SuperExpression extends PrimaryExpression { + readonly kind: SyntaxKind.SuperKeyword; + } + export interface ImportExpression extends PrimaryExpression { + readonly kind: SyntaxKind.ImportKeyword; + } + export interface DeleteExpression extends UnaryExpression { + readonly kind: SyntaxKind.DeleteExpression; + readonly expression: UnaryExpression; + } + export interface TypeOfExpression extends UnaryExpression { + readonly kind: SyntaxKind.TypeOfExpression; + readonly expression: UnaryExpression; + } + export interface VoidExpression extends UnaryExpression { + readonly kind: SyntaxKind.VoidExpression; + readonly expression: UnaryExpression; + } + export interface AwaitExpression extends UnaryExpression { + readonly kind: SyntaxKind.AwaitExpression; + readonly expression: UnaryExpression; + } + export interface YieldExpression extends Expression { + readonly kind: SyntaxKind.YieldExpression; + readonly asteriskToken?: AsteriskToken; + readonly expression?: Expression; + } + export interface SyntheticExpression extends Expression { + readonly kind: SyntaxKind.SyntheticExpression; + readonly isSpread: boolean; + readonly type: Type; + readonly tupleNameSource?: ParameterDeclaration | NamedTupleMember; + } + export type ExponentiationOperator = SyntaxKind.AsteriskAsteriskToken; + export type MultiplicativeOperator = SyntaxKind.AsteriskToken | SyntaxKind.SlashToken | SyntaxKind.PercentToken; + export type MultiplicativeOperatorOrHigher = ExponentiationOperator | MultiplicativeOperator; + export type AdditiveOperator = SyntaxKind.PlusToken | SyntaxKind.MinusToken; + export type AdditiveOperatorOrHigher = MultiplicativeOperatorOrHigher | AdditiveOperator; + export type ShiftOperator = SyntaxKind.LessThanLessThanToken | SyntaxKind.GreaterThanGreaterThanToken | SyntaxKind.GreaterThanGreaterThanGreaterThanToken; + export type ShiftOperatorOrHigher = AdditiveOperatorOrHigher | ShiftOperator; + export type RelationalOperator = SyntaxKind.LessThanToken | SyntaxKind.LessThanEqualsToken | SyntaxKind.GreaterThanToken | SyntaxKind.GreaterThanEqualsToken | SyntaxKind.InstanceOfKeyword | SyntaxKind.InKeyword; + export type RelationalOperatorOrHigher = ShiftOperatorOrHigher | RelationalOperator; + export type EqualityOperator = SyntaxKind.EqualsEqualsToken | SyntaxKind.EqualsEqualsEqualsToken | SyntaxKind.ExclamationEqualsEqualsToken | SyntaxKind.ExclamationEqualsToken; + export type EqualityOperatorOrHigher = RelationalOperatorOrHigher | EqualityOperator; + export type BitwiseOperator = SyntaxKind.AmpersandToken | SyntaxKind.BarToken | SyntaxKind.CaretToken; + export type BitwiseOperatorOrHigher = EqualityOperatorOrHigher | BitwiseOperator; + export type LogicalOperator = SyntaxKind.AmpersandAmpersandToken | SyntaxKind.BarBarToken; + export type LogicalOperatorOrHigher = BitwiseOperatorOrHigher | LogicalOperator; + export type CompoundAssignmentOperator = SyntaxKind.PlusEqualsToken | SyntaxKind.MinusEqualsToken | SyntaxKind.AsteriskAsteriskEqualsToken | SyntaxKind.AsteriskEqualsToken | SyntaxKind.SlashEqualsToken | SyntaxKind.PercentEqualsToken | SyntaxKind.AmpersandEqualsToken | SyntaxKind.BarEqualsToken | SyntaxKind.CaretEqualsToken | SyntaxKind.LessThanLessThanEqualsToken | SyntaxKind.GreaterThanGreaterThanGreaterThanEqualsToken | SyntaxKind.GreaterThanGreaterThanEqualsToken | SyntaxKind.BarBarEqualsToken | SyntaxKind.AmpersandAmpersandEqualsToken | SyntaxKind.QuestionQuestionEqualsToken; + export type AssignmentOperator = SyntaxKind.EqualsToken | CompoundAssignmentOperator; + export type AssignmentOperatorOrHigher = SyntaxKind.QuestionQuestionToken | LogicalOperatorOrHigher | AssignmentOperator; + export type BinaryOperator = AssignmentOperatorOrHigher | SyntaxKind.CommaToken; + export type LogicalOrCoalescingAssignmentOperator = SyntaxKind.AmpersandAmpersandEqualsToken | SyntaxKind.BarBarEqualsToken | SyntaxKind.QuestionQuestionEqualsToken; + export type BinaryOperatorToken = Token; + export interface BinaryExpression extends Expression, Declaration { + readonly kind: SyntaxKind.BinaryExpression; + readonly left: Expression; + readonly operatorToken: BinaryOperatorToken; + readonly right: Expression; + } + export type AssignmentOperatorToken = Token; + export interface AssignmentExpression extends BinaryExpression { + readonly left: LeftHandSideExpression; + readonly operatorToken: TOperator; + } + export interface ObjectDestructuringAssignment extends AssignmentExpression { + readonly left: ObjectLiteralExpression; + } + export interface ArrayDestructuringAssignment extends AssignmentExpression { + readonly left: ArrayLiteralExpression; + } + export type DestructuringAssignment = ObjectDestructuringAssignment | ArrayDestructuringAssignment; + export type BindingOrAssignmentElement = VariableDeclaration | ParameterDeclaration | ObjectBindingOrAssignmentElement | ArrayBindingOrAssignmentElement; + export type ObjectBindingOrAssignmentElement = BindingElement | PropertyAssignment | ShorthandPropertyAssignment | SpreadAssignment; + export type ArrayBindingOrAssignmentElement = BindingElement | OmittedExpression | SpreadElement | ArrayLiteralExpression | ObjectLiteralExpression | AssignmentExpression | Identifier | PropertyAccessExpression | ElementAccessExpression; + export type BindingOrAssignmentElementRestIndicator = DotDotDotToken | SpreadElement | SpreadAssignment; + export type BindingOrAssignmentElementTarget = BindingOrAssignmentPattern | Identifier | PropertyAccessExpression | ElementAccessExpression | OmittedExpression; + export type ObjectBindingOrAssignmentPattern = ObjectBindingPattern | ObjectLiteralExpression; + export type ArrayBindingOrAssignmentPattern = ArrayBindingPattern | ArrayLiteralExpression; + export type AssignmentPattern = ObjectLiteralExpression | ArrayLiteralExpression; + export type BindingOrAssignmentPattern = ObjectBindingOrAssignmentPattern | ArrayBindingOrAssignmentPattern; + export interface ConditionalExpression extends Expression { + readonly kind: SyntaxKind.ConditionalExpression; + readonly condition: Expression; + readonly questionToken: QuestionToken; + readonly whenTrue: Expression; + readonly colonToken: ColonToken; + readonly whenFalse: Expression; + } + export type FunctionBody = Block; + export type ConciseBody = FunctionBody | Expression; + export interface FunctionExpression extends PrimaryExpression, FunctionLikeDeclarationBase, JSDocContainer { + readonly kind: SyntaxKind.FunctionExpression; + readonly name?: Identifier; + readonly body: FunctionBody; + } + export interface ArrowFunction extends Expression, FunctionLikeDeclarationBase, JSDocContainer { + readonly kind: SyntaxKind.ArrowFunction; + readonly equalsGreaterThanToken: EqualsGreaterThanToken; + readonly body: ConciseBody; + readonly name: never; + } + export interface LiteralLikeNode extends Node { + text: string; + isUnterminated?: boolean; + hasExtendedUnicodeEscape?: boolean; + } + export interface TemplateLiteralLikeNode extends LiteralLikeNode { + rawText?: string; + } + export interface LiteralExpression extends LiteralLikeNode, PrimaryExpression { + _literalExpressionBrand: any; + } + export interface RegularExpressionLiteral extends LiteralExpression { + readonly kind: SyntaxKind.RegularExpressionLiteral; + } + export interface NoSubstitutionTemplateLiteral extends LiteralExpression, TemplateLiteralLikeNode, Declaration { + readonly kind: SyntaxKind.NoSubstitutionTemplateLiteral; + } + export enum TokenFlags { + None = 0, + Scientific = 16, + Octal = 32, + HexSpecifier = 64, + BinarySpecifier = 128, + OctalSpecifier = 256, + } + export interface NumericLiteral extends LiteralExpression, Declaration { + readonly kind: SyntaxKind.NumericLiteral; + } + export interface BigIntLiteral extends LiteralExpression { + readonly kind: SyntaxKind.BigIntLiteral; + } + export type LiteralToken = NumericLiteral | BigIntLiteral | StringLiteral | JsxText | RegularExpressionLiteral | NoSubstitutionTemplateLiteral; + export interface TemplateHead extends TemplateLiteralLikeNode { + readonly kind: SyntaxKind.TemplateHead; + readonly parent: TemplateExpression | TemplateLiteralTypeNode; + } + export interface TemplateMiddle extends TemplateLiteralLikeNode { + readonly kind: SyntaxKind.TemplateMiddle; + readonly parent: TemplateSpan | TemplateLiteralTypeSpan; + } + export interface TemplateTail extends TemplateLiteralLikeNode { + readonly kind: SyntaxKind.TemplateTail; + readonly parent: TemplateSpan | TemplateLiteralTypeSpan; + } + export type PseudoLiteralToken = TemplateHead | TemplateMiddle | TemplateTail; + export type TemplateLiteralToken = NoSubstitutionTemplateLiteral | PseudoLiteralToken; + export interface TemplateExpression extends PrimaryExpression { + readonly kind: SyntaxKind.TemplateExpression; + readonly head: TemplateHead; + readonly templateSpans: NodeArray; + } + export type TemplateLiteral = TemplateExpression | NoSubstitutionTemplateLiteral; + export interface TemplateSpan extends Node { + readonly kind: SyntaxKind.TemplateSpan; + readonly parent: TemplateExpression; + readonly expression: Expression; + readonly literal: TemplateMiddle | TemplateTail; + } + export interface ParenthesizedExpression extends PrimaryExpression, JSDocContainer { + readonly kind: SyntaxKind.ParenthesizedExpression; + readonly expression: Expression; + } + export interface ArrayLiteralExpression extends PrimaryExpression { + readonly kind: SyntaxKind.ArrayLiteralExpression; + readonly elements: NodeArray; + } + export interface SpreadElement extends Expression { + readonly kind: SyntaxKind.SpreadElement; + readonly parent: ArrayLiteralExpression | CallExpression | NewExpression; + readonly expression: Expression; + } + /** + * This interface is a base interface for ObjectLiteralExpression and JSXAttributes to extend from. JSXAttributes is similar to + * ObjectLiteralExpression in that it contains array of properties; however, JSXAttributes' properties can only be + * JSXAttribute or JSXSpreadAttribute. ObjectLiteralExpression, on the other hand, can only have properties of type + * ObjectLiteralElement (e.g. PropertyAssignment, ShorthandPropertyAssignment etc.) + */ + export interface ObjectLiteralExpressionBase extends PrimaryExpression, Declaration { + readonly properties: NodeArray; + } + export interface ObjectLiteralExpression extends ObjectLiteralExpressionBase { + readonly kind: SyntaxKind.ObjectLiteralExpression; + } + export type EntityNameExpression = Identifier | PropertyAccessEntityNameExpression; + export type EntityNameOrEntityNameExpression = EntityName | EntityNameExpression; + export type AccessExpression = PropertyAccessExpression | ElementAccessExpression; + export interface PropertyAccessExpression extends MemberExpression, NamedDeclaration { + readonly kind: SyntaxKind.PropertyAccessExpression; + readonly expression: LeftHandSideExpression; + readonly questionDotToken?: QuestionDotToken; + readonly name: Identifier | PrivateIdentifier; + } + export interface PropertyAccessChain extends PropertyAccessExpression { + _optionalChainBrand: any; + readonly name: Identifier | PrivateIdentifier; + } + export interface SuperPropertyAccessExpression extends PropertyAccessExpression { + readonly expression: SuperExpression; + } + /** Brand for a PropertyAccessExpression which, like a QualifiedName, consists of a sequence of identifiers separated by dots. */ + export interface PropertyAccessEntityNameExpression extends PropertyAccessExpression { + _propertyAccessExpressionLikeQualifiedNameBrand?: any; + readonly expression: EntityNameExpression; + readonly name: Identifier; + } + export interface ElementAccessExpression extends MemberExpression { + readonly kind: SyntaxKind.ElementAccessExpression; + readonly expression: LeftHandSideExpression; + readonly questionDotToken?: QuestionDotToken; + readonly argumentExpression: Expression; + } + export interface ElementAccessChain extends ElementAccessExpression { + _optionalChainBrand: any; + } + export interface SuperElementAccessExpression extends ElementAccessExpression { + readonly expression: SuperExpression; + } + export type SuperProperty = SuperPropertyAccessExpression | SuperElementAccessExpression; + export interface CallExpression extends LeftHandSideExpression, Declaration { + readonly kind: SyntaxKind.CallExpression; + readonly expression: LeftHandSideExpression; + readonly questionDotToken?: QuestionDotToken; + readonly typeArguments?: NodeArray; + readonly arguments: NodeArray; + } + export interface CallChain extends CallExpression { + _optionalChainBrand: any; + } + export type OptionalChain = PropertyAccessChain | ElementAccessChain | CallChain | NonNullChain; + export interface SuperCall extends CallExpression { + readonly expression: SuperExpression; + } + export interface ImportCall extends CallExpression { + readonly expression: ImportExpression; + } + export interface ExpressionWithTypeArguments extends NodeWithTypeArguments { + readonly kind: SyntaxKind.ExpressionWithTypeArguments; + readonly parent: HeritageClause | JSDocAugmentsTag | JSDocImplementsTag; + readonly expression: LeftHandSideExpression; + } + export interface NewExpression extends PrimaryExpression, Declaration { + readonly kind: SyntaxKind.NewExpression; + readonly expression: LeftHandSideExpression; + readonly typeArguments?: NodeArray; + readonly arguments?: NodeArray; + } + export interface TaggedTemplateExpression extends MemberExpression { + readonly kind: SyntaxKind.TaggedTemplateExpression; + readonly tag: LeftHandSideExpression; + readonly typeArguments?: NodeArray; + readonly template: TemplateLiteral; + } + export type CallLikeExpression = CallExpression | NewExpression | TaggedTemplateExpression | Decorator | JsxOpeningLikeElement; + export interface AsExpression extends Expression { + readonly kind: SyntaxKind.AsExpression; + readonly expression: Expression; + readonly type: TypeNode; + } + export interface TypeAssertion extends UnaryExpression { + readonly kind: SyntaxKind.TypeAssertionExpression; + readonly type: TypeNode; + readonly expression: UnaryExpression; + } + export type AssertionExpression = TypeAssertion | AsExpression; + export interface NonNullExpression extends LeftHandSideExpression { + readonly kind: SyntaxKind.NonNullExpression; + readonly expression: Expression; + } + export interface NonNullChain extends NonNullExpression { + _optionalChainBrand: any; + } + export interface MetaProperty extends PrimaryExpression { + readonly kind: SyntaxKind.MetaProperty; + readonly keywordToken: SyntaxKind.NewKeyword | SyntaxKind.ImportKeyword; + readonly name: Identifier; + } + export interface JsxElement extends PrimaryExpression { + readonly kind: SyntaxKind.JsxElement; + readonly openingElement: JsxOpeningElement; + readonly children: NodeArray; + readonly closingElement: JsxClosingElement; + } + export type JsxOpeningLikeElement = JsxSelfClosingElement | JsxOpeningElement; + export type JsxAttributeLike = JsxAttribute | JsxSpreadAttribute; + export type JsxTagNameExpression = Identifier | ThisExpression | JsxTagNamePropertyAccess; + export interface JsxTagNamePropertyAccess extends PropertyAccessExpression { + readonly expression: JsxTagNameExpression; + } + export interface JsxAttributes extends ObjectLiteralExpressionBase { + readonly kind: SyntaxKind.JsxAttributes; + readonly parent: JsxOpeningLikeElement; + } + export interface JsxOpeningElement extends Expression { + readonly kind: SyntaxKind.JsxOpeningElement; + readonly parent: JsxElement; + readonly tagName: JsxTagNameExpression; + readonly typeArguments?: NodeArray; + readonly attributes: JsxAttributes; + } + export interface JsxSelfClosingElement extends PrimaryExpression { + readonly kind: SyntaxKind.JsxSelfClosingElement; + readonly tagName: JsxTagNameExpression; + readonly typeArguments?: NodeArray; + readonly attributes: JsxAttributes; + } + export interface JsxFragment extends PrimaryExpression { + readonly kind: SyntaxKind.JsxFragment; + readonly openingFragment: JsxOpeningFragment; + readonly children: NodeArray; + readonly closingFragment: JsxClosingFragment; + } + export interface JsxOpeningFragment extends Expression { + readonly kind: SyntaxKind.JsxOpeningFragment; + readonly parent: JsxFragment; + } + export interface JsxClosingFragment extends Expression { + readonly kind: SyntaxKind.JsxClosingFragment; + readonly parent: JsxFragment; + } + export interface JsxAttribute extends ObjectLiteralElement { + readonly kind: SyntaxKind.JsxAttribute; + readonly parent: JsxAttributes; + readonly name: Identifier; + readonly initializer?: StringLiteral | JsxExpression; + } + export interface JsxSpreadAttribute extends ObjectLiteralElement { + readonly kind: SyntaxKind.JsxSpreadAttribute; + readonly parent: JsxAttributes; + readonly expression: Expression; + } + export interface JsxClosingElement extends Node { + readonly kind: SyntaxKind.JsxClosingElement; + readonly parent: JsxElement; + readonly tagName: JsxTagNameExpression; + } + export interface JsxExpression extends Expression { + readonly kind: SyntaxKind.JsxExpression; + readonly parent: JsxElement | JsxAttributeLike; + readonly dotDotDotToken?: Token; + readonly expression?: Expression; + } + export interface JsxText extends LiteralLikeNode { + readonly kind: SyntaxKind.JsxText; + readonly parent: JsxElement; + readonly containsOnlyTriviaWhiteSpaces: boolean; + } + export type JsxChild = JsxText | JsxExpression | JsxElement | JsxSelfClosingElement | JsxFragment; + export interface Statement extends Node { + _statementBrand: any; + } + export interface NotEmittedStatement extends Statement { + readonly kind: SyntaxKind.NotEmittedStatement; + } + /** + * A list of comma-separated expressions. This node is only created by transformations. + */ + export interface CommaListExpression extends Expression { + readonly kind: SyntaxKind.CommaListExpression; + readonly elements: NodeArray; + } + export interface EmptyStatement extends Statement { + readonly kind: SyntaxKind.EmptyStatement; + } + export interface DebuggerStatement extends Statement { + readonly kind: SyntaxKind.DebuggerStatement; + } + export interface MissingDeclaration extends DeclarationStatement { + readonly kind: SyntaxKind.MissingDeclaration; + readonly name?: Identifier; + } + export type BlockLike = SourceFile | Block | ModuleBlock | CaseOrDefaultClause; + export interface Block extends Statement { + readonly kind: SyntaxKind.Block; + readonly statements: NodeArray; + } + export interface VariableStatement extends Statement, JSDocContainer { + readonly kind: SyntaxKind.VariableStatement; + readonly declarationList: VariableDeclarationList; + } + export interface ExpressionStatement extends Statement, JSDocContainer { + readonly kind: SyntaxKind.ExpressionStatement; + readonly expression: Expression; + } + export interface IfStatement extends Statement { + readonly kind: SyntaxKind.IfStatement; + readonly expression: Expression; + readonly thenStatement: Statement; + readonly elseStatement?: Statement; + } + export interface IterationStatement extends Statement { + readonly statement: Statement; + } + export interface DoStatement extends IterationStatement { + readonly kind: SyntaxKind.DoStatement; + readonly expression: Expression; + } + export interface WhileStatement extends IterationStatement { + readonly kind: SyntaxKind.WhileStatement; + readonly expression: Expression; + } + export type ForInitializer = VariableDeclarationList | Expression; + export interface ForStatement extends IterationStatement { + readonly kind: SyntaxKind.ForStatement; + readonly initializer?: ForInitializer; + readonly condition?: Expression; + readonly incrementor?: Expression; + } + export type ForInOrOfStatement = ForInStatement | ForOfStatement; + export interface ForInStatement extends IterationStatement { + readonly kind: SyntaxKind.ForInStatement; + readonly initializer: ForInitializer; + readonly expression: Expression; + } + export interface ForOfStatement extends IterationStatement { + readonly kind: SyntaxKind.ForOfStatement; + readonly awaitModifier?: AwaitKeywordToken; + readonly initializer: ForInitializer; + readonly expression: Expression; + } + export interface BreakStatement extends Statement { + readonly kind: SyntaxKind.BreakStatement; + readonly label?: Identifier; + } + export interface ContinueStatement extends Statement { + readonly kind: SyntaxKind.ContinueStatement; + readonly label?: Identifier; + } + export type BreakOrContinueStatement = BreakStatement | ContinueStatement; + export interface ReturnStatement extends Statement { + readonly kind: SyntaxKind.ReturnStatement; + readonly expression?: Expression; + } + export interface WithStatement extends Statement { + readonly kind: SyntaxKind.WithStatement; + readonly expression: Expression; + readonly statement: Statement; + } + export interface SwitchStatement extends Statement { + readonly kind: SyntaxKind.SwitchStatement; + readonly expression: Expression; + readonly caseBlock: CaseBlock; + possiblyExhaustive?: boolean; + } + export interface CaseBlock extends Node { + readonly kind: SyntaxKind.CaseBlock; + readonly parent: SwitchStatement; + readonly clauses: NodeArray; + } + export interface CaseClause extends Node { + readonly kind: SyntaxKind.CaseClause; + readonly parent: CaseBlock; + readonly expression: Expression; + readonly statements: NodeArray; + } + export interface DefaultClause extends Node { + readonly kind: SyntaxKind.DefaultClause; + readonly parent: CaseBlock; + readonly statements: NodeArray; + } + export type CaseOrDefaultClause = CaseClause | DefaultClause; + export interface LabeledStatement extends Statement, JSDocContainer { + readonly kind: SyntaxKind.LabeledStatement; + readonly label: Identifier; + readonly statement: Statement; + } + export interface ThrowStatement extends Statement { + readonly kind: SyntaxKind.ThrowStatement; + readonly expression: Expression; + } + export interface TryStatement extends Statement { + readonly kind: SyntaxKind.TryStatement; + readonly tryBlock: Block; + readonly catchClause?: CatchClause; + readonly finallyBlock?: Block; + } + export interface CatchClause extends Node { + readonly kind: SyntaxKind.CatchClause; + readonly parent: TryStatement; + readonly variableDeclaration?: VariableDeclaration; + readonly block: Block; + } + export type ObjectTypeDeclaration = ClassLikeDeclaration | InterfaceDeclaration | TypeLiteralNode; + export type DeclarationWithTypeParameters = DeclarationWithTypeParameterChildren | JSDocTypedefTag | JSDocCallbackTag | JSDocSignature; + export type DeclarationWithTypeParameterChildren = SignatureDeclaration | ClassLikeDeclaration | InterfaceDeclaration | TypeAliasDeclaration | JSDocTemplateTag; + export interface ClassLikeDeclarationBase extends NamedDeclaration, JSDocContainer { + readonly kind: SyntaxKind.ClassDeclaration | SyntaxKind.ClassExpression; + readonly name?: Identifier; + readonly typeParameters?: NodeArray; + readonly heritageClauses?: NodeArray; + readonly members: NodeArray; + } + export interface ClassDeclaration extends ClassLikeDeclarationBase, DeclarationStatement { + readonly kind: SyntaxKind.ClassDeclaration; + /** May be undefined in `export default class { ... }`. */ + readonly name?: Identifier; + } + export interface ClassExpression extends ClassLikeDeclarationBase, PrimaryExpression { + readonly kind: SyntaxKind.ClassExpression; + } + export type ClassLikeDeclaration = ClassDeclaration | ClassExpression; + export interface ClassElement extends NamedDeclaration { + _classElementBrand: any; + readonly name?: PropertyName; + } + export interface TypeElement extends NamedDeclaration { + _typeElementBrand: any; + readonly name?: PropertyName; + readonly questionToken?: QuestionToken; + } + export interface InterfaceDeclaration extends DeclarationStatement, JSDocContainer { + readonly kind: SyntaxKind.InterfaceDeclaration; + readonly name: Identifier; + readonly typeParameters?: NodeArray; + readonly heritageClauses?: NodeArray; + readonly members: NodeArray; + } + export interface HeritageClause extends Node { + readonly kind: SyntaxKind.HeritageClause; + readonly parent: InterfaceDeclaration | ClassLikeDeclaration; + readonly token: SyntaxKind.ExtendsKeyword | SyntaxKind.ImplementsKeyword; + readonly types: NodeArray; + } + export interface TypeAliasDeclaration extends DeclarationStatement, JSDocContainer { + readonly kind: SyntaxKind.TypeAliasDeclaration; + readonly name: Identifier; + readonly typeParameters?: NodeArray; + readonly type: TypeNode; + } + export interface EnumMember extends NamedDeclaration, JSDocContainer { + readonly kind: SyntaxKind.EnumMember; + readonly parent: EnumDeclaration; + readonly name: PropertyName; + readonly initializer?: Expression; + } + export interface EnumDeclaration extends DeclarationStatement, JSDocContainer { + readonly kind: SyntaxKind.EnumDeclaration; + readonly name: Identifier; + readonly members: NodeArray; + } + export type ModuleName = Identifier | StringLiteral; + export type ModuleBody = NamespaceBody | JSDocNamespaceBody; + export interface ModuleDeclaration extends DeclarationStatement, JSDocContainer { + readonly kind: SyntaxKind.ModuleDeclaration; + readonly parent: ModuleBody | SourceFile; + readonly name: ModuleName; + readonly body?: ModuleBody | JSDocNamespaceDeclaration; + } + export type NamespaceBody = ModuleBlock | NamespaceDeclaration; + export interface NamespaceDeclaration extends ModuleDeclaration { + readonly name: Identifier; + readonly body: NamespaceBody; + } + export type JSDocNamespaceBody = Identifier | JSDocNamespaceDeclaration; + export interface JSDocNamespaceDeclaration extends ModuleDeclaration { + readonly name: Identifier; + readonly body?: JSDocNamespaceBody; + } + export interface ModuleBlock extends Node, Statement { + readonly kind: SyntaxKind.ModuleBlock; + readonly parent: ModuleDeclaration; + readonly statements: NodeArray; + } + export type ModuleReference = EntityName | ExternalModuleReference; + /** + * One of: + * - import x = require("mod"); + * - import x = M.x; + */ + export interface ImportEqualsDeclaration extends DeclarationStatement, JSDocContainer { + readonly kind: SyntaxKind.ImportEqualsDeclaration; + readonly parent: SourceFile | ModuleBlock; + readonly name: Identifier; + readonly moduleReference: ModuleReference; + } + export interface ExternalModuleReference extends Node { + readonly kind: SyntaxKind.ExternalModuleReference; + readonly parent: ImportEqualsDeclaration; + readonly expression: Expression; + } + export interface ImportDeclaration extends Statement, JSDocContainer { + readonly kind: SyntaxKind.ImportDeclaration; + readonly parent: SourceFile | ModuleBlock; + readonly importClause?: ImportClause; + /** If this is not a StringLiteral it will be a grammar error. */ + readonly moduleSpecifier: Expression; + } + export type NamedImportBindings = NamespaceImport | NamedImports; + export type NamedExportBindings = NamespaceExport | NamedExports; + export interface ImportClause extends NamedDeclaration { + readonly kind: SyntaxKind.ImportClause; + readonly parent: ImportDeclaration; + readonly isTypeOnly: boolean; + readonly name?: Identifier; + readonly namedBindings?: NamedImportBindings; + } + export interface NamespaceImport extends NamedDeclaration { + readonly kind: SyntaxKind.NamespaceImport; + readonly parent: ImportClause; + readonly name: Identifier; + } + export interface NamespaceExport extends NamedDeclaration { + readonly kind: SyntaxKind.NamespaceExport; + readonly parent: ExportDeclaration; + readonly name: Identifier; + } + export interface NamespaceExportDeclaration extends DeclarationStatement, JSDocContainer { + readonly kind: SyntaxKind.NamespaceExportDeclaration; + readonly name: Identifier; + } + export interface ExportDeclaration extends DeclarationStatement, JSDocContainer { + readonly kind: SyntaxKind.ExportDeclaration; + readonly parent: SourceFile | ModuleBlock; + readonly isTypeOnly: boolean; + /** Will not be assigned in the case of `export * from "foo";` */ + readonly exportClause?: NamedExportBindings; + /** If this is not a StringLiteral it will be a grammar error. */ + readonly moduleSpecifier?: Expression; + } + export interface NamedImports extends Node { + readonly kind: SyntaxKind.NamedImports; + readonly parent: ImportClause; + readonly elements: NodeArray; + } + export interface NamedExports extends Node { + readonly kind: SyntaxKind.NamedExports; + readonly parent: ExportDeclaration; + readonly elements: NodeArray; + } + export type NamedImportsOrExports = NamedImports | NamedExports; + export interface ImportSpecifier extends NamedDeclaration { + readonly kind: SyntaxKind.ImportSpecifier; + readonly parent: NamedImports; + readonly propertyName?: Identifier; + readonly name: Identifier; + } + export interface ExportSpecifier extends NamedDeclaration { + readonly kind: SyntaxKind.ExportSpecifier; + readonly parent: NamedExports; + readonly propertyName?: Identifier; + readonly name: Identifier; + } + export type ImportOrExportSpecifier = ImportSpecifier | ExportSpecifier; + export type TypeOnlyCompatibleAliasDeclaration = ImportClause | NamespaceImport | ImportOrExportSpecifier; + /** + * This is either an `export =` or an `export default` declaration. + * Unless `isExportEquals` is set, this node was parsed as an `export default`. + */ + export interface ExportAssignment extends DeclarationStatement, JSDocContainer { + readonly kind: SyntaxKind.ExportAssignment; + readonly parent: SourceFile; + readonly isExportEquals?: boolean; + readonly expression: Expression; + } + export interface FileReference extends TextRange { + fileName: string; + } + export interface CheckJsDirective extends TextRange { + enabled: boolean; + } + export type CommentKind = SyntaxKind.SingleLineCommentTrivia | SyntaxKind.MultiLineCommentTrivia; + export interface CommentRange extends TextRange { + hasTrailingNewLine?: boolean; + kind: CommentKind; + } + export interface SynthesizedComment extends CommentRange { + text: string; + pos: -1; + end: -1; + hasLeadingNewline?: boolean; + } + export interface JSDocTypeExpression extends TypeNode { + readonly kind: SyntaxKind.JSDocTypeExpression; + readonly type: TypeNode; + } + export interface JSDocNameReference extends Node { + readonly kind: SyntaxKind.JSDocNameReference; + readonly name: EntityName; + } + export interface JSDocType extends TypeNode { + _jsDocTypeBrand: any; + } + export interface JSDocAllType extends JSDocType { + readonly kind: SyntaxKind.JSDocAllType; + } + export interface JSDocUnknownType extends JSDocType { + readonly kind: SyntaxKind.JSDocUnknownType; + } + export interface JSDocNonNullableType extends JSDocType { + readonly kind: SyntaxKind.JSDocNonNullableType; + readonly type: TypeNode; + } + export interface JSDocNullableType extends JSDocType { + readonly kind: SyntaxKind.JSDocNullableType; + readonly type: TypeNode; + } + export interface JSDocOptionalType extends JSDocType { + readonly kind: SyntaxKind.JSDocOptionalType; + readonly type: TypeNode; + } + export interface JSDocFunctionType extends JSDocType, SignatureDeclarationBase { + readonly kind: SyntaxKind.JSDocFunctionType; + } + export interface JSDocVariadicType extends JSDocType { + readonly kind: SyntaxKind.JSDocVariadicType; + readonly type: TypeNode; + } + export interface JSDocNamepathType extends JSDocType { + readonly kind: SyntaxKind.JSDocNamepathType; + readonly type: TypeNode; + } + export type JSDocTypeReferencingNode = JSDocVariadicType | JSDocOptionalType | JSDocNullableType | JSDocNonNullableType; + export interface JSDoc extends Node { + readonly kind: SyntaxKind.JSDocComment; + readonly parent: HasJSDoc; + readonly tags?: NodeArray; + readonly comment?: string; + } + export interface JSDocTag extends Node { + readonly parent: JSDoc | JSDocTypeLiteral; + readonly tagName: Identifier; + readonly comment?: string; + } + export interface JSDocUnknownTag extends JSDocTag { + readonly kind: SyntaxKind.JSDocTag; + } + /** + * Note that `@extends` is a synonym of `@augments`. + * Both tags are represented by this interface. + */ + export interface JSDocAugmentsTag extends JSDocTag { + readonly kind: SyntaxKind.JSDocAugmentsTag; + readonly class: ExpressionWithTypeArguments & { + readonly expression: Identifier | PropertyAccessEntityNameExpression; + }; + } + export interface JSDocImplementsTag extends JSDocTag { + readonly kind: SyntaxKind.JSDocImplementsTag; + readonly class: ExpressionWithTypeArguments & { + readonly expression: Identifier | PropertyAccessEntityNameExpression; + }; + } + export interface JSDocAuthorTag extends JSDocTag { + readonly kind: SyntaxKind.JSDocAuthorTag; + } + export interface JSDocDeprecatedTag extends JSDocTag { + kind: SyntaxKind.JSDocDeprecatedTag; + } + export interface JSDocClassTag extends JSDocTag { + readonly kind: SyntaxKind.JSDocClassTag; + } + export interface JSDocPublicTag extends JSDocTag { + readonly kind: SyntaxKind.JSDocPublicTag; + } + export interface JSDocPrivateTag extends JSDocTag { + readonly kind: SyntaxKind.JSDocPrivateTag; + } + export interface JSDocProtectedTag extends JSDocTag { + readonly kind: SyntaxKind.JSDocProtectedTag; + } + export interface JSDocReadonlyTag extends JSDocTag { + readonly kind: SyntaxKind.JSDocReadonlyTag; + } + export interface JSDocEnumTag extends JSDocTag, Declaration { + readonly kind: SyntaxKind.JSDocEnumTag; + readonly parent: JSDoc; + readonly typeExpression: JSDocTypeExpression; + } + export interface JSDocThisTag extends JSDocTag { + readonly kind: SyntaxKind.JSDocThisTag; + readonly typeExpression: JSDocTypeExpression; + } + export interface JSDocTemplateTag extends JSDocTag { + readonly kind: SyntaxKind.JSDocTemplateTag; + readonly constraint: JSDocTypeExpression | undefined; + readonly typeParameters: NodeArray; + } + export interface JSDocSeeTag extends JSDocTag { + readonly kind: SyntaxKind.JSDocSeeTag; + readonly name?: JSDocNameReference; + } + export interface JSDocReturnTag extends JSDocTag { + readonly kind: SyntaxKind.JSDocReturnTag; + readonly typeExpression?: JSDocTypeExpression; + } + export interface JSDocTypeTag extends JSDocTag { + readonly kind: SyntaxKind.JSDocTypeTag; + readonly typeExpression: JSDocTypeExpression; + } + export interface JSDocTypedefTag extends JSDocTag, NamedDeclaration { + readonly kind: SyntaxKind.JSDocTypedefTag; + readonly parent: JSDoc; + readonly fullName?: JSDocNamespaceDeclaration | Identifier; + readonly name?: Identifier; + readonly typeExpression?: JSDocTypeExpression | JSDocTypeLiteral; + } + export interface JSDocCallbackTag extends JSDocTag, NamedDeclaration { + readonly kind: SyntaxKind.JSDocCallbackTag; + readonly parent: JSDoc; + readonly fullName?: JSDocNamespaceDeclaration | Identifier; + readonly name?: Identifier; + readonly typeExpression: JSDocSignature; + } + export interface JSDocSignature extends JSDocType, Declaration { + readonly kind: SyntaxKind.JSDocSignature; + readonly typeParameters?: readonly JSDocTemplateTag[]; + readonly parameters: readonly JSDocParameterTag[]; + readonly type: JSDocReturnTag | undefined; + } + export interface JSDocPropertyLikeTag extends JSDocTag, Declaration { + readonly parent: JSDoc; + readonly name: EntityName; + readonly typeExpression?: JSDocTypeExpression; + /** Whether the property name came before the type -- non-standard for JSDoc, but Typescript-like */ + readonly isNameFirst: boolean; + readonly isBracketed: boolean; + } + export interface JSDocPropertyTag extends JSDocPropertyLikeTag { + readonly kind: SyntaxKind.JSDocPropertyTag; + } + export interface JSDocParameterTag extends JSDocPropertyLikeTag { + readonly kind: SyntaxKind.JSDocParameterTag; + } + export interface JSDocTypeLiteral extends JSDocType { + readonly kind: SyntaxKind.JSDocTypeLiteral; + readonly jsDocPropertyTags?: readonly JSDocPropertyLikeTag[]; + /** If true, then this type literal represents an *array* of its type. */ + readonly isArrayType: boolean; + } + export enum FlowFlags { + Unreachable = 1, + Start = 2, + BranchLabel = 4, + LoopLabel = 8, + Assignment = 16, + TrueCondition = 32, + FalseCondition = 64, + SwitchClause = 128, + ArrayMutation = 256, + Call = 512, + ReduceLabel = 1024, + Referenced = 2048, + Shared = 4096, + Label = 12, + Condition = 96 + } + export type FlowNode = FlowStart | FlowLabel | FlowAssignment | FlowCall | FlowCondition | FlowSwitchClause | FlowArrayMutation | FlowCall | FlowReduceLabel; + export interface FlowNodeBase { + flags: FlowFlags; + id?: number; + } + export interface FlowStart extends FlowNodeBase { + node?: FunctionExpression | ArrowFunction | MethodDeclaration; + } + export interface FlowLabel extends FlowNodeBase { + antecedents: FlowNode[] | undefined; + } + export interface FlowAssignment extends FlowNodeBase { + node: Expression | VariableDeclaration | BindingElement; + antecedent: FlowNode; + } + export interface FlowCall extends FlowNodeBase { + node: CallExpression; + antecedent: FlowNode; + } + export interface FlowCondition extends FlowNodeBase { + node: Expression; + antecedent: FlowNode; + } + export interface FlowSwitchClause extends FlowNodeBase { + switchStatement: SwitchStatement; + clauseStart: number; + clauseEnd: number; + antecedent: FlowNode; + } + export interface FlowArrayMutation extends FlowNodeBase { + node: CallExpression | BinaryExpression; + antecedent: FlowNode; + } + export interface FlowReduceLabel extends FlowNodeBase { + target: FlowLabel; + antecedents: FlowNode[]; + antecedent: FlowNode; + } + export type FlowType = Type | IncompleteType; + export interface IncompleteType { + flags: TypeFlags; + type: Type; + } + export interface AmdDependency { + path: string; + name?: string; + } + export interface SourceFile extends Declaration { + readonly kind: SyntaxKind.SourceFile; + readonly statements: NodeArray; + readonly endOfFileToken: Token; + fileName: string; + text: string; + amdDependencies: readonly AmdDependency[]; + moduleName?: string; + referencedFiles: readonly FileReference[]; + typeReferenceDirectives: readonly FileReference[]; + libReferenceDirectives: readonly FileReference[]; + languageVariant: LanguageVariant; + isDeclarationFile: boolean; + /** + * lib.d.ts should have a reference comment like + * + * /// + * + * If any other file has this comment, it signals not to include lib.d.ts + * because this containing file is intended to act as a default library. + */ + hasNoDefaultLib: boolean; + languageVersion: ScriptTarget; + } + export interface Bundle extends Node { + readonly kind: SyntaxKind.Bundle; + readonly prepends: readonly (InputFiles | UnparsedSource)[]; + readonly sourceFiles: readonly SourceFile[]; + } + export interface InputFiles extends Node { + readonly kind: SyntaxKind.InputFiles; + javascriptPath?: string; + javascriptText: string; + javascriptMapPath?: string; + javascriptMapText?: string; + declarationPath?: string; + declarationText: string; + declarationMapPath?: string; + declarationMapText?: string; + } + export interface UnparsedSource extends Node { + readonly kind: SyntaxKind.UnparsedSource; + fileName: string; + text: string; + readonly prologues: readonly UnparsedPrologue[]; + helpers: readonly UnscopedEmitHelper[] | undefined; + referencedFiles: readonly FileReference[]; + typeReferenceDirectives: readonly string[] | undefined; + libReferenceDirectives: readonly FileReference[]; + hasNoDefaultLib?: boolean; + sourceMapPath?: string; + sourceMapText?: string; + readonly syntheticReferences?: readonly UnparsedSyntheticReference[]; + readonly texts: readonly UnparsedSourceText[]; + } + export type UnparsedSourceText = UnparsedPrepend | UnparsedTextLike; + export type UnparsedNode = UnparsedPrologue | UnparsedSourceText | UnparsedSyntheticReference; + export interface UnparsedSection extends Node { + readonly kind: SyntaxKind; + readonly parent: UnparsedSource; + readonly data?: string; + } + export interface UnparsedPrologue extends UnparsedSection { + readonly kind: SyntaxKind.UnparsedPrologue; + readonly parent: UnparsedSource; + readonly data: string; + } + export interface UnparsedPrepend extends UnparsedSection { + readonly kind: SyntaxKind.UnparsedPrepend; + readonly parent: UnparsedSource; + readonly data: string; + readonly texts: readonly UnparsedTextLike[]; + } + export interface UnparsedTextLike extends UnparsedSection { + readonly kind: SyntaxKind.UnparsedText | SyntaxKind.UnparsedInternalText; + readonly parent: UnparsedSource; + } + export interface UnparsedSyntheticReference extends UnparsedSection { + readonly kind: SyntaxKind.UnparsedSyntheticReference; + readonly parent: UnparsedSource; + } + export interface JsonSourceFile extends SourceFile { + readonly statements: NodeArray; + } + export interface TsConfigSourceFile extends JsonSourceFile { + extendedSourceFiles?: string[]; + } + export interface JsonMinusNumericLiteral extends PrefixUnaryExpression { + readonly kind: SyntaxKind.PrefixUnaryExpression; + readonly operator: SyntaxKind.MinusToken; + readonly operand: NumericLiteral; + } + export type JsonObjectExpression = ObjectLiteralExpression | ArrayLiteralExpression | JsonMinusNumericLiteral | NumericLiteral | StringLiteral | BooleanLiteral | NullLiteral; + export interface JsonObjectExpressionStatement extends ExpressionStatement { + readonly expression: JsonObjectExpression; + } + export interface ScriptReferenceHost { + getCompilerOptions(): CompilerOptions; + getSourceFile(fileName: string): SourceFile | undefined; + getSourceFileByPath(path: Path): SourceFile | undefined; + getCurrentDirectory(): string; + } + export interface ParseConfigHost { + useCaseSensitiveFileNames: boolean; + readDirectory(rootDir: string, extensions: readonly string[], excludes: readonly string[] | undefined, includes: readonly string[], depth?: number): readonly string[]; + /** + * Gets a value indicating whether the specified path exists and is a file. + * @param path The path to test. + */ + fileExists(path: string): boolean; + readFile(path: string): string | undefined; + trace?(s: string): void; + } + /** + * Branded string for keeping track of when we've turned an ambiguous path + * specified like "./blah" to an absolute path to an actual + * tsconfig file, e.g. "/root/blah/tsconfig.json" + */ + export type ResolvedConfigFileName = string & { + _isResolvedConfigFileName: never; + }; + export type WriteFileCallback = (fileName: string, data: string, writeByteOrderMark: boolean, onError?: (message: string) => void, sourceFiles?: readonly SourceFile[]) => void; + export class OperationCanceledException { + } + export interface CancellationToken { + isCancellationRequested(): boolean; + /** @throws OperationCanceledException if isCancellationRequested is true */ + throwIfCancellationRequested(): void; + } + export interface Program extends ScriptReferenceHost { + getCurrentDirectory(): string; + /** + * Get a list of root file names that were passed to a 'createProgram' + */ + getRootFileNames(): readonly string[]; + /** + * Get a list of files in the program + */ + getSourceFiles(): readonly SourceFile[]; + /** + * Emits the JavaScript and declaration files. If targetSourceFile is not specified, then + * the JavaScript and declaration files will be produced for all the files in this program. + * If targetSourceFile is specified, then only the JavaScript and declaration for that + * specific file will be generated. + * + * If writeFile is not specified then the writeFile callback from the compiler host will be + * used for writing the JavaScript and declaration files. Otherwise, the writeFile parameter + * will be invoked when writing the JavaScript and declaration files. + */ + emit(targetSourceFile?: SourceFile, writeFile?: WriteFileCallback, cancellationToken?: CancellationToken, emitOnlyDtsFiles?: boolean, customTransformers?: CustomTransformers): EmitResult; + getOptionsDiagnostics(cancellationToken?: CancellationToken): readonly Diagnostic[]; + getGlobalDiagnostics(cancellationToken?: CancellationToken): readonly Diagnostic[]; + getSyntacticDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): readonly DiagnosticWithLocation[]; + /** The first time this is called, it will return global diagnostics (no location). */ + getSemanticDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): readonly Diagnostic[]; + getDeclarationDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): readonly DiagnosticWithLocation[]; + getConfigFileParsingDiagnostics(): readonly Diagnostic[]; + /** + * Gets a type checker that can be used to semantically analyze source files in the program. + */ + getTypeChecker(): TypeChecker; + getTypeCatalog(): readonly Type[]; + getNodeCount(): number; + getIdentifierCount(): number; + getSymbolCount(): number; + getTypeCount(): number; + getInstantiationCount(): number; + getRelationCacheSizes(): { + assignable: number; + identity: number; + subtype: number; + strictSubtype: number; + }; + isSourceFileFromExternalLibrary(file: SourceFile): boolean; + isSourceFileDefaultLibrary(file: SourceFile): boolean; + getProjectReferences(): readonly ProjectReference[] | undefined; + getResolvedProjectReferences(): readonly (ResolvedProjectReference | undefined)[] | undefined; + } + export interface ResolvedProjectReference { + commandLine: ParsedCommandLine; + sourceFile: SourceFile; + references?: readonly (ResolvedProjectReference | undefined)[]; + } + export type CustomTransformerFactory = (context: TransformationContext) => CustomTransformer; + export interface CustomTransformer { + transformSourceFile(node: SourceFile): SourceFile; + transformBundle(node: Bundle): Bundle; + } + export interface CustomTransformers { + /** Custom transformers to evaluate before built-in .js transformations. */ + before?: (TransformerFactory | CustomTransformerFactory)[]; + /** Custom transformers to evaluate after built-in .js transformations. */ + after?: (TransformerFactory | CustomTransformerFactory)[]; + /** Custom transformers to evaluate after built-in .d.ts transformations. */ + afterDeclarations?: (TransformerFactory | CustomTransformerFactory)[]; + } + export interface SourceMapSpan { + /** Line number in the .js file. */ + emittedLine: number; + /** Column number in the .js file. */ + emittedColumn: number; + /** Line number in the .ts file. */ + sourceLine: number; + /** Column number in the .ts file. */ + sourceColumn: number; + /** Optional name (index into names array) associated with this span. */ + nameIndex?: number; + /** .ts file (index into sources array) associated with this span */ + sourceIndex: number; + } + /** Return code used by getEmitOutput function to indicate status of the function */ + export enum ExitStatus { + Success = 0, + DiagnosticsPresent_OutputsSkipped = 1, + DiagnosticsPresent_OutputsGenerated = 2, + InvalidProject_OutputsSkipped = 3, + ProjectReferenceCycle_OutputsSkipped = 4, + /** @deprecated Use ProjectReferenceCycle_OutputsSkipped instead. */ + ProjectReferenceCycle_OutputsSkupped = 4 + } + export interface EmitResult { + emitSkipped: boolean; + /** Contains declaration emit diagnostics */ + diagnostics: readonly Diagnostic[]; + emittedFiles?: string[]; + } + export interface TypeChecker { + getTypeOfSymbolAtLocation(symbol: Symbol, node: Node): Type; + getDeclaredTypeOfSymbol(symbol: Symbol): Type; + getPropertiesOfType(type: Type): Symbol[]; + getPropertyOfType(type: Type, propertyName: string): Symbol | undefined; + getPrivateIdentifierPropertyOfType(leftType: Type, name: string, location: Node): Symbol | undefined; + getIndexInfoOfType(type: Type, kind: IndexKind): IndexInfo | undefined; + getSignaturesOfType(type: Type, kind: SignatureKind): readonly Signature[]; + getIndexTypeOfType(type: Type, kind: IndexKind): Type | undefined; + getBaseTypes(type: InterfaceType): BaseType[]; + getBaseTypeOfLiteralType(type: Type): Type; + getWidenedType(type: Type): Type; + getReturnTypeOfSignature(signature: Signature): Type; + getNullableType(type: Type, flags: TypeFlags): Type; + getNonNullableType(type: Type): Type; + getTypeArguments(type: TypeReference): readonly Type[]; + /** Note that the resulting nodes cannot be checked. */ + typeToTypeNode(type: Type, enclosingDeclaration: Node | undefined, flags: NodeBuilderFlags | undefined): TypeNode | undefined; + /** Note that the resulting nodes cannot be checked. */ + signatureToSignatureDeclaration(signature: Signature, kind: SyntaxKind, enclosingDeclaration: Node | undefined, flags: NodeBuilderFlags | undefined): SignatureDeclaration & { + typeArguments?: NodeArray; + } | undefined; + /** Note that the resulting nodes cannot be checked. */ + indexInfoToIndexSignatureDeclaration(indexInfo: IndexInfo, kind: IndexKind, enclosingDeclaration: Node | undefined, flags: NodeBuilderFlags | undefined): IndexSignatureDeclaration | undefined; + /** Note that the resulting nodes cannot be checked. */ + symbolToEntityName(symbol: Symbol, meaning: SymbolFlags, enclosingDeclaration: Node | undefined, flags: NodeBuilderFlags | undefined): EntityName | undefined; + /** Note that the resulting nodes cannot be checked. */ + symbolToExpression(symbol: Symbol, meaning: SymbolFlags, enclosingDeclaration: Node | undefined, flags: NodeBuilderFlags | undefined): Expression | undefined; + /** Note that the resulting nodes cannot be checked. */ + symbolToTypeParameterDeclarations(symbol: Symbol, enclosingDeclaration: Node | undefined, flags: NodeBuilderFlags | undefined): NodeArray | undefined; + /** Note that the resulting nodes cannot be checked. */ + symbolToParameterDeclaration(symbol: Symbol, enclosingDeclaration: Node | undefined, flags: NodeBuilderFlags | undefined): ParameterDeclaration | undefined; + /** Note that the resulting nodes cannot be checked. */ + typeParameterToDeclaration(parameter: TypeParameter, enclosingDeclaration: Node | undefined, flags: NodeBuilderFlags | undefined): TypeParameterDeclaration | undefined; + getSymbolsInScope(location: Node, meaning: SymbolFlags): Symbol[]; + getSymbolAtLocation(node: Node): Symbol | undefined; + getSymbolsOfParameterPropertyDeclaration(parameter: ParameterDeclaration, parameterName: string): Symbol[]; + /** + * The function returns the value (local variable) symbol of an identifier in the short-hand property assignment. + * This is necessary as an identifier in short-hand property assignment can contains two meaning: property name and property value. + */ + getShorthandAssignmentValueSymbol(location: Node): Symbol | undefined; + getExportSpecifierLocalTargetSymbol(location: ExportSpecifier | Identifier): Symbol | undefined; + /** + * If a symbol is a local symbol with an associated exported symbol, returns the exported symbol. + * Otherwise returns its input. + * For example, at `export type T = number;`: + * - `getSymbolAtLocation` at the location `T` will return the exported symbol for `T`. + * - But the result of `getSymbolsInScope` will contain the *local* symbol for `T`, not the exported symbol. + * - Calling `getExportSymbolOfSymbol` on that local symbol will return the exported symbol. + */ + getExportSymbolOfSymbol(symbol: Symbol): Symbol; + getPropertySymbolOfDestructuringAssignment(location: Identifier): Symbol | undefined; + getTypeOfAssignmentPattern(pattern: AssignmentPattern): Type; + getTypeAtLocation(node: Node): Type; + getTypeFromTypeNode(node: TypeNode): Type; + signatureToString(signature: Signature, enclosingDeclaration?: Node, flags?: TypeFormatFlags, kind?: SignatureKind): string; + typeToString(type: Type, enclosingDeclaration?: Node, flags?: TypeFormatFlags): string; + symbolToString(symbol: Symbol, enclosingDeclaration?: Node, meaning?: SymbolFlags, flags?: SymbolFormatFlags): string; + typePredicateToString(predicate: TypePredicate, enclosingDeclaration?: Node, flags?: TypeFormatFlags): string; + getFullyQualifiedName(symbol: Symbol): string; + getAugmentedPropertiesOfType(type: Type): Symbol[]; + getRootSymbols(symbol: Symbol): readonly Symbol[]; + getSymbolOfExpando(node: Node, allowDeclaration: boolean): Symbol | undefined; + getContextualType(node: Expression): Type | undefined; + /** + * returns unknownSignature in the case of an error. + * returns undefined if the node is not valid. + * @param argumentCount Apparent number of arguments, passed in case of a possibly incomplete call. This should come from an ArgumentListInfo. See `signatureHelp.ts`. + */ + getResolvedSignature(node: CallLikeExpression, candidatesOutArray?: Signature[], argumentCount?: number): Signature | undefined; + getSignatureFromDeclaration(declaration: SignatureDeclaration): Signature | undefined; + isImplementationOfOverload(node: SignatureDeclaration): boolean | undefined; + isUndefinedSymbol(symbol: Symbol): boolean; + isArgumentsSymbol(symbol: Symbol): boolean; + isUnknownSymbol(symbol: Symbol): boolean; + getConstantValue(node: EnumMember | PropertyAccessExpression | ElementAccessExpression): string | number | undefined; + isValidPropertyAccess(node: PropertyAccessExpression | QualifiedName | ImportTypeNode, propertyName: string): boolean; + /** Follow all aliases to get the original symbol. */ + getAliasedSymbol(symbol: Symbol): Symbol; + getExportsOfModule(moduleSymbol: Symbol): Symbol[]; + getJsxIntrinsicTagNamesAt(location: Node): Symbol[]; + isOptionalParameter(node: ParameterDeclaration): boolean; + getAmbientModules(): Symbol[]; + tryGetMemberInModuleExports(memberName: string, moduleSymbol: Symbol): Symbol | undefined; + getApparentType(type: Type): Type; + getBaseConstraintOfType(type: Type): Type | undefined; + getDefaultFromTypeParameter(type: Type): Type | undefined; + /** + * Depending on the operation performed, it may be appropriate to throw away the checker + * if the cancellation token is triggered. Typically, if it is used for error checking + * and the operation is cancelled, then it should be discarded, otherwise it is safe to keep. + */ + runWithCancellationToken(token: CancellationToken, cb: (checker: TypeChecker) => T): T; + } + export enum NodeBuilderFlags { + None = 0, + NoTruncation = 1, + WriteArrayAsGenericType = 2, + GenerateNamesForShadowedTypeParams = 4, + UseStructuralFallback = 8, + ForbidIndexedAccessSymbolReferences = 16, + WriteTypeArgumentsOfSignature = 32, + UseFullyQualifiedType = 64, + UseOnlyExternalAliasing = 128, + SuppressAnyReturnType = 256, + WriteTypeParametersInQualifiedName = 512, + MultilineObjectLiterals = 1024, + WriteClassExpressionAsTypeLiteral = 2048, + UseTypeOfFunction = 4096, + OmitParameterModifiers = 8192, + UseAliasDefinedOutsideCurrentScope = 16384, + UseSingleQuotesForStringLiteralType = 268435456, + NoTypeReduction = 536870912, + NoUndefinedOptionalParameterType = 1073741824, + AllowThisInObjectLiteral = 32768, + AllowQualifedNameInPlaceOfIdentifier = 65536, + AllowAnonymousIdentifier = 131072, + AllowEmptyUnionOrIntersection = 262144, + AllowEmptyTuple = 524288, + AllowUniqueESSymbolType = 1048576, + AllowEmptyIndexInfoType = 2097152, + AllowNodeModulesRelativePaths = 67108864, + IgnoreErrors = 70221824, + InObjectTypeLiteral = 4194304, + InTypeAlias = 8388608, + InInitialEntityName = 16777216, + InReverseMappedType = 33554432 + } + export enum TypeFormatFlags { + None = 0, + NoTruncation = 1, + WriteArrayAsGenericType = 2, + UseStructuralFallback = 8, + WriteTypeArgumentsOfSignature = 32, + UseFullyQualifiedType = 64, + SuppressAnyReturnType = 256, + MultilineObjectLiterals = 1024, + WriteClassExpressionAsTypeLiteral = 2048, + UseTypeOfFunction = 4096, + OmitParameterModifiers = 8192, + UseAliasDefinedOutsideCurrentScope = 16384, + UseSingleQuotesForStringLiteralType = 268435456, + NoTypeReduction = 536870912, + AllowUniqueESSymbolType = 1048576, + AddUndefined = 131072, + WriteArrowStyleSignature = 262144, + InArrayType = 524288, + InElementType = 2097152, + InFirstTypeArgument = 4194304, + InTypeAlias = 8388608, + /** @deprecated */ WriteOwnNameForAnyLike = 0, + NodeBuilderFlagsMask = 814775659 + } + export enum SymbolFormatFlags { + None = 0, + WriteTypeParametersOrArguments = 1, + UseOnlyExternalAliasing = 2, + AllowAnyNodeKind = 4, + UseAliasDefinedOutsideCurrentScope = 8, + } + export enum TypePredicateKind { + This = 0, + Identifier = 1, + AssertsThis = 2, + AssertsIdentifier = 3 + } + export interface TypePredicateBase { + kind: TypePredicateKind; + type: Type | undefined; + } + export interface ThisTypePredicate extends TypePredicateBase { + kind: TypePredicateKind.This; + parameterName: undefined; + parameterIndex: undefined; + type: Type; + } + export interface IdentifierTypePredicate extends TypePredicateBase { + kind: TypePredicateKind.Identifier; + parameterName: string; + parameterIndex: number; + type: Type; + } + export interface AssertsThisTypePredicate extends TypePredicateBase { + kind: TypePredicateKind.AssertsThis; + parameterName: undefined; + parameterIndex: undefined; + type: Type | undefined; + } + export interface AssertsIdentifierTypePredicate extends TypePredicateBase { + kind: TypePredicateKind.AssertsIdentifier; + parameterName: string; + parameterIndex: number; + type: Type | undefined; + } + export type TypePredicate = ThisTypePredicate | IdentifierTypePredicate | AssertsThisTypePredicate | AssertsIdentifierTypePredicate; + export enum SymbolFlags { + None = 0, + FunctionScopedVariable = 1, + BlockScopedVariable = 2, + Property = 4, + EnumMember = 8, + Function = 16, + Class = 32, + Interface = 64, + ConstEnum = 128, + RegularEnum = 256, + ValueModule = 512, + NamespaceModule = 1024, + TypeLiteral = 2048, + ObjectLiteral = 4096, + Method = 8192, + Constructor = 16384, + GetAccessor = 32768, + SetAccessor = 65536, + Signature = 131072, + TypeParameter = 262144, + TypeAlias = 524288, + ExportValue = 1048576, + Alias = 2097152, + Prototype = 4194304, + ExportStar = 8388608, + Optional = 16777216, + Transient = 33554432, + Assignment = 67108864, + ModuleExports = 134217728, + Enum = 384, + Variable = 3, + Value = 111551, + Type = 788968, + Namespace = 1920, + Module = 1536, + Accessor = 98304, + FunctionScopedVariableExcludes = 111550, + BlockScopedVariableExcludes = 111551, + ParameterExcludes = 111551, + PropertyExcludes = 0, + EnumMemberExcludes = 900095, + FunctionExcludes = 110991, + ClassExcludes = 899503, + InterfaceExcludes = 788872, + RegularEnumExcludes = 899327, + ConstEnumExcludes = 899967, + ValueModuleExcludes = 110735, + NamespaceModuleExcludes = 0, + MethodExcludes = 103359, + GetAccessorExcludes = 46015, + SetAccessorExcludes = 78783, + TypeParameterExcludes = 526824, + TypeAliasExcludes = 788968, + AliasExcludes = 2097152, + ModuleMember = 2623475, + ExportHasLocal = 944, + BlockScoped = 418, + PropertyOrAccessor = 98308, + ClassMember = 106500, + } + export interface Symbol { + flags: SymbolFlags; + escapedName: __String; + declarations: Declaration[]; + valueDeclaration: Declaration; + members?: SymbolTable; + exports?: SymbolTable; + globalExports?: SymbolTable; + } + export enum InternalSymbolName { + Call = "__call", + Constructor = "__constructor", + New = "__new", + Index = "__index", + ExportStar = "__export", + Global = "__global", + Missing = "__missing", + Type = "__type", + Object = "__object", + JSXAttributes = "__jsxAttributes", + Class = "__class", + Function = "__function", + Computed = "__computed", + Resolving = "__resolving__", + ExportEquals = "export=", + Default = "default", + This = "this" + } + /** + * This represents a string whose leading underscore have been escaped by adding extra leading underscores. + * The shape of this brand is rather unique compared to others we've used. + * Instead of just an intersection of a string and an object, it is that union-ed + * with an intersection of void and an object. This makes it wholly incompatible + * with a normal string (which is good, it cannot be misused on assignment or on usage), + * while still being comparable with a normal string via === (also good) and castable from a string. + */ + export type __String = (string & { + __escapedIdentifier: void; + }) | (void & { + __escapedIdentifier: void; + }) | InternalSymbolName; + /** ReadonlyMap where keys are `__String`s. */ + export interface ReadonlyUnderscoreEscapedMap extends ReadonlyESMap<__String, T> { + } + /** Map where keys are `__String`s. */ + export interface UnderscoreEscapedMap extends ESMap<__String, T>, ReadonlyUnderscoreEscapedMap { + } + /** SymbolTable based on ES6 Map interface. */ + export type SymbolTable = UnderscoreEscapedMap; + export enum TypeFlags { + Any = 1, + Unknown = 2, + String = 4, + Number = 8, + Boolean = 16, + Enum = 32, + BigInt = 64, + StringLiteral = 128, + NumberLiteral = 256, + BooleanLiteral = 512, + EnumLiteral = 1024, + BigIntLiteral = 2048, + ESSymbol = 4096, + UniqueESSymbol = 8192, + Void = 16384, + Undefined = 32768, + Null = 65536, + Never = 131072, + TypeParameter = 262144, + Object = 524288, + Union = 1048576, + Intersection = 2097152, + Index = 4194304, + IndexedAccess = 8388608, + Conditional = 16777216, + Substitution = 33554432, + NonPrimitive = 67108864, + TemplateLiteral = 134217728, + StringMapping = 268435456, + Literal = 2944, + Unit = 109440, + StringOrNumberLiteral = 384, + PossiblyFalsy = 117724, + StringLike = 402653316, + NumberLike = 296, + BigIntLike = 2112, + BooleanLike = 528, + EnumLike = 1056, + ESSymbolLike = 12288, + VoidLike = 49152, + UnionOrIntersection = 3145728, + StructuredType = 3670016, + TypeVariable = 8650752, + InstantiableNonPrimitive = 58982400, + InstantiablePrimitive = 406847488, + Instantiable = 465829888, + StructuredOrInstantiable = 469499904, + Narrowable = 536624127, + } + export type DestructuringPattern = BindingPattern | ObjectLiteralExpression | ArrayLiteralExpression; + export interface Type { + flags: TypeFlags; + symbol: Symbol; + pattern?: DestructuringPattern; + aliasSymbol?: Symbol; + aliasTypeArguments?: readonly Type[]; + } + export interface LiteralType extends Type { + value: string | number | PseudoBigInt; + freshType: LiteralType; + regularType: LiteralType; + } + export interface UniqueESSymbolType extends Type { + symbol: Symbol; + escapedName: __String; + } + export interface StringLiteralType extends LiteralType { + value: string; + } + export interface NumberLiteralType extends LiteralType { + value: number; + } + export interface BigIntLiteralType extends LiteralType { + value: PseudoBigInt; + } + export interface EnumType extends Type { + } + export enum ObjectFlags { + Class = 1, + Interface = 2, + Reference = 4, + Tuple = 8, + Anonymous = 16, + Mapped = 32, + Instantiated = 64, + ObjectLiteral = 128, + EvolvingArray = 256, + ObjectLiteralPatternWithComputedProperties = 512, + ContainsSpread = 1024, + ReverseMapped = 2048, + JsxAttributes = 4096, + MarkerType = 8192, + JSLiteral = 16384, + FreshLiteral = 32768, + ArrayLiteral = 65536, + ObjectRestType = 131072, + ClassOrInterface = 3, + } + export interface ObjectType extends Type { + objectFlags: ObjectFlags; + } + /** Class and interface types (ObjectFlags.Class and ObjectFlags.Interface). */ + export interface InterfaceType extends ObjectType { + typeParameters: TypeParameter[] | undefined; + outerTypeParameters: TypeParameter[] | undefined; + localTypeParameters: TypeParameter[] | undefined; + thisType: TypeParameter | undefined; + } + export type BaseType = ObjectType | IntersectionType | TypeVariable; + export interface InterfaceTypeWithDeclaredMembers extends InterfaceType { + declaredProperties: Symbol[]; + declaredCallSignatures: Signature[]; + declaredConstructSignatures: Signature[]; + declaredStringIndexInfo?: IndexInfo; + declaredNumberIndexInfo?: IndexInfo; + } + /** + * Type references (ObjectFlags.Reference). When a class or interface has type parameters or + * a "this" type, references to the class or interface are made using type references. The + * typeArguments property specifies the types to substitute for the type parameters of the + * class or interface and optionally includes an extra element that specifies the type to + * substitute for "this" in the resulting instantiation. When no extra argument is present, + * the type reference itself is substituted for "this". The typeArguments property is undefined + * if the class or interface has no type parameters and the reference isn't specifying an + * explicit "this" argument. + */ + export interface TypeReference extends ObjectType { + target: GenericType; + node?: TypeReferenceNode | ArrayTypeNode | TupleTypeNode; + } + export interface DeferredTypeReference extends TypeReference { + } + export interface GenericType extends InterfaceType, TypeReference { + } + export enum ElementFlags { + Required = 1, + Optional = 2, + Rest = 4, + Variadic = 8, + Variable = 12 + } + export interface TupleType extends GenericType { + elementFlags: readonly ElementFlags[]; + minLength: number; + fixedLength: number; + hasRestElement: boolean; + combinedFlags: ElementFlags; + readonly: boolean; + labeledElementDeclarations?: readonly (NamedTupleMember | ParameterDeclaration)[]; + } + export interface TupleTypeReference extends TypeReference { + target: TupleType; + } + export interface UnionOrIntersectionType extends Type { + types: Type[]; + } + export interface UnionType extends UnionOrIntersectionType { + } + export interface IntersectionType extends UnionOrIntersectionType { + } + export type StructuredType = ObjectType | UnionType | IntersectionType; + export interface EvolvingArrayType extends ObjectType { + elementType: Type; + finalArrayType?: Type; + } + export interface InstantiableType extends Type { + } + export interface TypeParameter extends InstantiableType { + } + export interface IndexedAccessType extends InstantiableType { + objectType: Type; + indexType: Type; + constraint?: Type; + simplifiedForReading?: Type; + simplifiedForWriting?: Type; + } + export type TypeVariable = TypeParameter | IndexedAccessType; + export interface IndexType extends InstantiableType { + type: InstantiableType | UnionOrIntersectionType; + } + export interface ConditionalRoot { + node: ConditionalTypeNode; + checkType: Type; + extendsType: Type; + isDistributive: boolean; + inferTypeParameters?: TypeParameter[]; + outerTypeParameters?: TypeParameter[]; + instantiations?: Map; + aliasSymbol?: Symbol; + aliasTypeArguments?: Type[]; + } + export interface ConditionalType extends InstantiableType { + root: ConditionalRoot; + checkType: Type; + extendsType: Type; + resolvedTrueType: Type; + resolvedFalseType: Type; + } + export interface TemplateLiteralType extends InstantiableType { + texts: readonly string[]; + types: readonly Type[]; + } + export interface StringMappingType extends InstantiableType { + symbol: Symbol; + type: Type; + } + export interface SubstitutionType extends InstantiableType { + baseType: Type; + substitute: Type; + } + export enum SignatureKind { + Call = 0, + Construct = 1 + } + export interface Signature { + declaration?: SignatureDeclaration | JSDocSignature; + typeParameters?: readonly TypeParameter[]; + parameters: readonly Symbol[]; + } + export enum IndexKind { + String = 0, + Number = 1 + } + export interface IndexInfo { + type: Type; + isReadonly: boolean; + declaration?: IndexSignatureDeclaration; + } + export enum InferencePriority { + NakedTypeVariable = 1, + SpeculativeTuple = 2, + HomomorphicMappedType = 4, + PartialHomomorphicMappedType = 8, + MappedTypeConstraint = 16, + ContravariantConditional = 32, + ReturnType = 64, + LiteralKeyof = 128, + NoConstraints = 256, + AlwaysStrict = 512, + MaxValue = 1024, + PriorityImpliesCombination = 208, + Circularity = -1 + } + /** @deprecated Use FileExtensionInfo instead. */ + export type JsFileExtensionInfo = FileExtensionInfo; + export interface FileExtensionInfo { + extension: string; + isMixedContent: boolean; + scriptKind?: ScriptKind; + } + export interface DiagnosticMessage { + key: string; + category: DiagnosticCategory; + code: number; + message: string; + reportsUnnecessary?: {}; + reportsDeprecated?: {}; + } + /** + * A linked list of formatted diagnostic messages to be used as part of a multiline message. + * It is built from the bottom up, leaving the head to be the "main" diagnostic. + * While it seems that DiagnosticMessageChain is structurally similar to DiagnosticMessage, + * the difference is that messages are all preformatted in DMC. + */ + export interface DiagnosticMessageChain { + messageText: string; + category: DiagnosticCategory; + code: number; + next?: DiagnosticMessageChain[]; + } + export interface Diagnostic extends DiagnosticRelatedInformation { + /** May store more in future. For now, this will simply be `true` to indicate when a diagnostic is an unused-identifier diagnostic. */ + reportsUnnecessary?: {}; + reportsDeprecated?: {}; + source?: string; + relatedInformation?: DiagnosticRelatedInformation[]; + } + export interface DiagnosticRelatedInformation { + category: DiagnosticCategory; + code: number; + file: SourceFile | undefined; + start: number | undefined; + length: number | undefined; + messageText: string | DiagnosticMessageChain; + } + export interface DiagnosticWithLocation extends Diagnostic { + file: SourceFile; + start: number; + length: number; + } + export enum DiagnosticCategory { + Warning = 0, + Error = 1, + Suggestion = 2, + Message = 3 + } + export enum ModuleResolutionKind { + Classic = 1, + NodeJs = 2 + } + export interface PluginImport { + name: string; + } + export interface ProjectReference { + /** A normalized path on disk */ + path: string; + /** The path as the user originally wrote it */ + originalPath?: string; + /** True if the output of this reference should be prepended to the output of this project. Only valid for --outFile compilations */ + prepend?: boolean; + /** True if it is intended that this reference form a circularity */ + circular?: boolean; + } + export enum WatchFileKind { + FixedPollingInterval = 0, + PriorityPollingInterval = 1, + DynamicPriorityPolling = 2, + UseFsEvents = 3, + UseFsEventsOnParentDirectory = 4 + } + export enum WatchDirectoryKind { + UseFsEvents = 0, + FixedPollingInterval = 1, + DynamicPriorityPolling = 2 + } + export enum PollingWatchKind { + FixedInterval = 0, + PriorityInterval = 1, + DynamicPriority = 2 + } + export type CompilerOptionsValue = string | number | boolean | (string | number)[] | string[] | MapLike | PluginImport[] | ProjectReference[] | null | undefined; + export interface CompilerOptions { + allowJs?: boolean; + allowSyntheticDefaultImports?: boolean; + allowUmdGlobalAccess?: boolean; + allowUnreachableCode?: boolean; + allowUnusedLabels?: boolean; + alwaysStrict?: boolean; + baseUrl?: string; + charset?: string; + checkJs?: boolean; + declaration?: boolean; + declarationMap?: boolean; + emitDeclarationOnly?: boolean; + declarationDir?: string; + disableSizeLimit?: boolean; + disableSourceOfProjectReferenceRedirect?: boolean; + disableSolutionSearching?: boolean; + disableReferencedProjectLoad?: boolean; + downlevelIteration?: boolean; + emitBOM?: boolean; + emitDecoratorMetadata?: boolean; + experimentalDecorators?: boolean; + forceConsistentCasingInFileNames?: boolean; + importHelpers?: boolean; + importsNotUsedAsValues?: ImportsNotUsedAsValues; + inlineSourceMap?: boolean; + inlineSources?: boolean; + isolatedModules?: boolean; + jsx?: JsxEmit; + keyofStringsOnly?: boolean; + lib?: string[]; + locale?: string; + mapRoot?: string; + maxNodeModuleJsDepth?: number; + module?: ModuleKind; + moduleResolution?: ModuleResolutionKind; + newLine?: NewLineKind; + noEmit?: boolean; + noEmitHelpers?: boolean; + noEmitOnError?: boolean; + noErrorTruncation?: boolean; + noFallthroughCasesInSwitch?: boolean; + noImplicitAny?: boolean; + noImplicitReturns?: boolean; + noImplicitThis?: boolean; + noStrictGenericChecks?: boolean; + noUnusedLocals?: boolean; + noUnusedParameters?: boolean; + noImplicitUseStrict?: boolean; + assumeChangesOnlyAffectDirectDependencies?: boolean; + noLib?: boolean; + noResolve?: boolean; + noUncheckedIndexedAccess?: boolean; + out?: string; + outDir?: string; + outFile?: string; + paths?: MapLike; + preserveConstEnums?: boolean; + preserveSymlinks?: boolean; + project?: string; + reactNamespace?: string; + jsxFactory?: string; + jsxFragmentFactory?: string; + jsxImportSource?: string; + composite?: boolean; + incremental?: boolean; + tsBuildInfoFile?: string; + removeComments?: boolean; + rootDir?: string; + rootDirs?: string[]; + skipLibCheck?: boolean; + skipDefaultLibCheck?: boolean; + sourceMap?: boolean; + sourceRoot?: string; + strict?: boolean; + strictFunctionTypes?: boolean; + strictBindCallApply?: boolean; + strictNullChecks?: boolean; + strictPropertyInitialization?: boolean; + stripInternal?: boolean; + suppressExcessPropertyErrors?: boolean; + suppressImplicitAnyIndexErrors?: boolean; + target?: ScriptTarget; + traceResolution?: boolean; + resolveJsonModule?: boolean; + types?: string[]; + /** Paths used to compute primary types search locations */ + typeRoots?: string[]; + esModuleInterop?: boolean; + useDefineForClassFields?: boolean; + [option: string]: CompilerOptionsValue | TsConfigSourceFile | undefined; + } + export interface WatchOptions { + watchFile?: WatchFileKind; + watchDirectory?: WatchDirectoryKind; + fallbackPolling?: PollingWatchKind; + synchronousWatchDirectory?: boolean; + [option: string]: CompilerOptionsValue | undefined; + } + export interface TypeAcquisition { + /** + * @deprecated typingOptions.enableAutoDiscovery + * Use typeAcquisition.enable instead. + */ + enableAutoDiscovery?: boolean; + enable?: boolean; + include?: string[]; + exclude?: string[]; + disableFilenameBasedTypeAcquisition?: boolean; + [option: string]: CompilerOptionsValue | undefined; + } + export enum ModuleKind { + None = 0, + CommonJS = 1, + AMD = 2, + UMD = 3, + System = 4, + ES2015 = 5, + ES2020 = 6, + ESNext = 99 + } + export enum JsxEmit { + None = 0, + Preserve = 1, + React = 2, + ReactNative = 3, + ReactJSX = 4, + ReactJSXDev = 5 + } + export enum ImportsNotUsedAsValues { + Remove = 0, + Preserve = 1, + Error = 2 + } + export enum NewLineKind { + CarriageReturnLineFeed = 0, + LineFeed = 1 + } + export interface LineAndCharacter { + /** 0-based. */ + line: number; + character: number; + } + export enum ScriptKind { + Unknown = 0, + JS = 1, + JSX = 2, + TS = 3, + TSX = 4, + External = 5, + JSON = 6, + /** + * Used on extensions that doesn't define the ScriptKind but the content defines it. + * Deferred extensions are going to be included in all project contexts. + */ + Deferred = 7 + } + export enum ScriptTarget { + ES3 = 0, + ES5 = 1, + ES2015 = 2, + ES2016 = 3, + ES2017 = 4, + ES2018 = 5, + ES2019 = 6, + ES2020 = 7, + ESNext = 99, + JSON = 100, + Latest = 99 + } + export enum LanguageVariant { + Standard = 0, + JSX = 1 + } + /** Either a parsed command line or a parsed tsconfig.json */ + export interface ParsedCommandLine { + options: CompilerOptions; + typeAcquisition?: TypeAcquisition; + fileNames: string[]; + projectReferences?: readonly ProjectReference[]; + watchOptions?: WatchOptions; + raw?: any; + errors: Diagnostic[]; + wildcardDirectories?: MapLike; + compileOnSave?: boolean; + } + export enum WatchDirectoryFlags { + None = 0, + Recursive = 1 + } + export interface ExpandResult { + fileNames: string[]; + wildcardDirectories: MapLike; + } + export interface CreateProgramOptions { + rootNames: readonly string[]; + options: CompilerOptions; + projectReferences?: readonly ProjectReference[]; + host?: CompilerHost; + oldProgram?: Program; + configFileParsingDiagnostics?: readonly Diagnostic[]; + } + export interface ModuleResolutionHost { + fileExists(fileName: string): boolean; + readFile(fileName: string): string | undefined; + trace?(s: string): void; + directoryExists?(directoryName: string): boolean; + /** + * Resolve a symbolic link. + * @see https://nodejs.org/api/fs.html#fs_fs_realpathsync_path_options + */ + realpath?(path: string): string; + getCurrentDirectory?(): string; + getDirectories?(path: string): string[]; + } + /** + * Represents the result of module resolution. + * Module resolution will pick up tsx/jsx/js files even if '--jsx' and '--allowJs' are turned off. + * The Program will then filter results based on these flags. + * + * Prefer to return a `ResolvedModuleFull` so that the file type does not have to be inferred. + */ + export interface ResolvedModule { + /** Path of the file the module was resolved to. */ + resolvedFileName: string; + /** True if `resolvedFileName` comes from `node_modules`. */ + isExternalLibraryImport?: boolean; + } + /** + * ResolvedModule with an explicitly provided `extension` property. + * Prefer this over `ResolvedModule`. + * If changing this, remember to change `moduleResolutionIsEqualTo`. + */ + export interface ResolvedModuleFull extends ResolvedModule { + /** + * Extension of resolvedFileName. This must match what's at the end of resolvedFileName. + * This is optional for backwards-compatibility, but will be added if not provided. + */ + extension: Extension; + packageId?: PackageId; + } + /** + * Unique identifier with a package name and version. + * If changing this, remember to change `packageIdIsEqual`. + */ + export interface PackageId { + /** + * Name of the package. + * Should not include `@types`. + * If accessing a non-index file, this should include its name e.g. "foo/bar". + */ + name: string; + /** + * Name of a submodule within this package. + * May be "". + */ + subModuleName: string; + /** Version of the package, e.g. "1.2.3" */ + version: string; + } + export enum Extension { + Ts = ".ts", + Tsx = ".tsx", + Dts = ".d.ts", + Js = ".js", + Jsx = ".jsx", + Json = ".json", + TsBuildInfo = ".tsbuildinfo" + } + export interface ResolvedModuleWithFailedLookupLocations { + readonly resolvedModule: ResolvedModuleFull | undefined; + } + export interface ResolvedTypeReferenceDirective { + primary: boolean; + resolvedFileName: string | undefined; + packageId?: PackageId; + /** True if `resolvedFileName` comes from `node_modules`. */ + isExternalLibraryImport?: boolean; + } + export interface ResolvedTypeReferenceDirectiveWithFailedLookupLocations { + readonly resolvedTypeReferenceDirective: ResolvedTypeReferenceDirective | undefined; + readonly failedLookupLocations: string[]; + } + export interface CompilerHost extends ModuleResolutionHost { + getSourceFile(fileName: string, languageVersion: ScriptTarget, onError?: (message: string) => void, shouldCreateNewSourceFile?: boolean): SourceFile | undefined; + getSourceFileByPath?(fileName: string, path: Path, languageVersion: ScriptTarget, onError?: (message: string) => void, shouldCreateNewSourceFile?: boolean): SourceFile | undefined; + getCancellationToken?(): CancellationToken; + getDefaultLibFileName(options: CompilerOptions): string; + getDefaultLibLocation?(): string; + writeFile: WriteFileCallback; + getCurrentDirectory(): string; + getCanonicalFileName(fileName: string): string; + useCaseSensitiveFileNames(): boolean; + getNewLine(): string; + readDirectory?(rootDir: string, extensions: readonly string[], excludes: readonly string[] | undefined, includes: readonly string[], depth?: number): string[]; + resolveModuleNames?(moduleNames: string[], containingFile: string, reusedNames: string[] | undefined, redirectedReference: ResolvedProjectReference | undefined, options: CompilerOptions): (ResolvedModule | undefined)[]; + /** + * This method is a companion for 'resolveModuleNames' and is used to resolve 'types' references to actual type declaration files + */ + resolveTypeReferenceDirectives?(typeReferenceDirectiveNames: string[], containingFile: string, redirectedReference: ResolvedProjectReference | undefined, options: CompilerOptions): (ResolvedTypeReferenceDirective | undefined)[]; + getEnvironmentVariable?(name: string): string | undefined; + createHash?(data: string): string; + getParsedCommandLine?(fileName: string): ParsedCommandLine | undefined; + } + export interface SourceMapRange extends TextRange { + source?: SourceMapSource; + } + export interface SourceMapSource { + fileName: string; + text: string; + skipTrivia?: (pos: number) => number; + } + export enum EmitFlags { + None = 0, + SingleLine = 1, + AdviseOnEmitNode = 2, + NoSubstitution = 4, + CapturesThis = 8, + NoLeadingSourceMap = 16, + NoTrailingSourceMap = 32, + NoSourceMap = 48, + NoNestedSourceMaps = 64, + NoTokenLeadingSourceMaps = 128, + NoTokenTrailingSourceMaps = 256, + NoTokenSourceMaps = 384, + NoLeadingComments = 512, + NoTrailingComments = 1024, + NoComments = 1536, + NoNestedComments = 2048, + HelperName = 4096, + ExportName = 8192, + LocalName = 16384, + InternalName = 32768, + Indented = 65536, + NoIndentation = 131072, + AsyncFunctionBody = 262144, + ReuseTempVariableScope = 524288, + CustomPrologue = 1048576, + NoHoisting = 2097152, + HasEndOfDeclarationMarker = 4194304, + Iterator = 8388608, + NoAsciiEscaping = 16777216, + } + export interface EmitHelper { + readonly name: string; + readonly scoped: boolean; + readonly text: string | ((node: EmitHelperUniqueNameCallback) => string); + readonly priority?: number; + readonly dependencies?: EmitHelper[]; + } + export interface UnscopedEmitHelper extends EmitHelper { + readonly scoped: false; + readonly text: string; + } + export type EmitHelperUniqueNameCallback = (name: string) => string; + export enum EmitHint { + SourceFile = 0, + Expression = 1, + IdentifierName = 2, + MappedTypeParameter = 3, + Unspecified = 4, + EmbeddedStatement = 5, + JsxAttributeValue = 6 + } + export enum OuterExpressionKinds { + Parentheses = 1, + TypeAssertions = 2, + NonNullAssertions = 4, + PartiallyEmittedExpressions = 8, + Assertions = 6, + All = 15 + } + export type TypeOfTag = "undefined" | "number" | "bigint" | "boolean" | "string" | "symbol" | "object" | "function"; + export interface NodeFactory { + createNodeArray(elements?: readonly T[], hasTrailingComma?: boolean): NodeArray; + createNumericLiteral(value: string | number, numericLiteralFlags?: TokenFlags): NumericLiteral; + createBigIntLiteral(value: string | PseudoBigInt): BigIntLiteral; + createStringLiteral(text: string, isSingleQuote?: boolean): StringLiteral; + createStringLiteralFromNode(sourceNode: PropertyNameLiteral, isSingleQuote?: boolean): StringLiteral; + createRegularExpressionLiteral(text: string): RegularExpressionLiteral; + createIdentifier(text: string): Identifier; + /** Create a unique temporary variable. */ + createTempVariable(recordTempVariable: ((node: Identifier) => void) | undefined): Identifier; + /** Create a unique temporary variable for use in a loop. */ + createLoopVariable(): Identifier; + /** Create a unique name based on the supplied text. */ + createUniqueName(text: string, flags?: GeneratedIdentifierFlags): Identifier; + /** Create a unique name generated for a node. */ + getGeneratedNameForNode(node: Node | undefined): Identifier; + createPrivateIdentifier(text: string): PrivateIdentifier; + createToken(token: SyntaxKind.SuperKeyword): SuperExpression; + createToken(token: SyntaxKind.ThisKeyword): ThisExpression; + createToken(token: SyntaxKind.NullKeyword): NullLiteral; + createToken(token: SyntaxKind.TrueKeyword): TrueLiteral; + createToken(token: SyntaxKind.FalseKeyword): FalseLiteral; + createToken(token: TKind): PunctuationToken; + createToken(token: TKind): KeywordTypeNode; + createToken(token: TKind): ModifierToken; + createToken(token: TKind): KeywordToken; + createToken(token: TKind): Token; + createSuper(): SuperExpression; + createThis(): ThisExpression; + createNull(): NullLiteral; + createTrue(): TrueLiteral; + createFalse(): FalseLiteral; + createModifier(kind: T): ModifierToken; + createModifiersFromModifierFlags(flags: ModifierFlags): Modifier[]; + createQualifiedName(left: EntityName, right: string | Identifier): QualifiedName; + updateQualifiedName(node: QualifiedName, left: EntityName, right: Identifier): QualifiedName; + createComputedPropertyName(expression: Expression): ComputedPropertyName; + updateComputedPropertyName(node: ComputedPropertyName, expression: Expression): ComputedPropertyName; + createTypeParameterDeclaration(name: string | Identifier, constraint?: TypeNode, defaultType?: TypeNode): TypeParameterDeclaration; + updateTypeParameterDeclaration(node: TypeParameterDeclaration, name: Identifier, constraint: TypeNode | undefined, defaultType: TypeNode | undefined): TypeParameterDeclaration; + createParameterDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, dotDotDotToken: DotDotDotToken | undefined, name: string | BindingName, questionToken?: QuestionToken, type?: TypeNode, initializer?: Expression): ParameterDeclaration; + updateParameterDeclaration(node: ParameterDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, dotDotDotToken: DotDotDotToken | undefined, name: string | BindingName, questionToken: QuestionToken | undefined, type: TypeNode | undefined, initializer: Expression | undefined): ParameterDeclaration; + createDecorator(expression: Expression): Decorator; + updateDecorator(node: Decorator, expression: Expression): Decorator; + createPropertySignature(modifiers: readonly Modifier[] | undefined, name: PropertyName | string, questionToken: QuestionToken | undefined, type: TypeNode | undefined): PropertySignature; + updatePropertySignature(node: PropertySignature, modifiers: readonly Modifier[] | undefined, name: PropertyName, questionToken: QuestionToken | undefined, type: TypeNode | undefined): PropertySignature; + createPropertyDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | PropertyName, questionOrExclamationToken: QuestionToken | ExclamationToken | undefined, type: TypeNode | undefined, initializer: Expression | undefined): PropertyDeclaration; + updatePropertyDeclaration(node: PropertyDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | PropertyName, questionOrExclamationToken: QuestionToken | ExclamationToken | undefined, type: TypeNode | undefined, initializer: Expression | undefined): PropertyDeclaration; + createMethodSignature(modifiers: readonly Modifier[] | undefined, name: string | PropertyName, questionToken: QuestionToken | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined): MethodSignature; + updateMethodSignature(node: MethodSignature, modifiers: readonly Modifier[] | undefined, name: PropertyName, questionToken: QuestionToken | undefined, typeParameters: NodeArray | undefined, parameters: NodeArray, type: TypeNode | undefined): MethodSignature; + createMethodDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, asteriskToken: AsteriskToken | undefined, name: string | PropertyName, questionToken: QuestionToken | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, body: Block | undefined): MethodDeclaration; + updateMethodDeclaration(node: MethodDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, asteriskToken: AsteriskToken | undefined, name: PropertyName, questionToken: QuestionToken | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, body: Block | undefined): MethodDeclaration; + createConstructorDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, parameters: readonly ParameterDeclaration[], body: Block | undefined): ConstructorDeclaration; + updateConstructorDeclaration(node: ConstructorDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, parameters: readonly ParameterDeclaration[], body: Block | undefined): ConstructorDeclaration; + createGetAccessorDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | PropertyName, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, body: Block | undefined): GetAccessorDeclaration; + updateGetAccessorDeclaration(node: GetAccessorDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: PropertyName, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, body: Block | undefined): GetAccessorDeclaration; + createSetAccessorDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | PropertyName, parameters: readonly ParameterDeclaration[], body: Block | undefined): SetAccessorDeclaration; + updateSetAccessorDeclaration(node: SetAccessorDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: PropertyName, parameters: readonly ParameterDeclaration[], body: Block | undefined): SetAccessorDeclaration; + createCallSignature(typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined): CallSignatureDeclaration; + updateCallSignature(node: CallSignatureDeclaration, typeParameters: NodeArray | undefined, parameters: NodeArray, type: TypeNode | undefined): CallSignatureDeclaration; + createConstructSignature(typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined): ConstructSignatureDeclaration; + updateConstructSignature(node: ConstructSignatureDeclaration, typeParameters: NodeArray | undefined, parameters: NodeArray, type: TypeNode | undefined): ConstructSignatureDeclaration; + createIndexSignature(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode): IndexSignatureDeclaration; + updateIndexSignature(node: IndexSignatureDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode): IndexSignatureDeclaration; + createTemplateLiteralTypeSpan(type: TypeNode, literal: TemplateMiddle | TemplateTail): TemplateLiteralTypeSpan; + updateTemplateLiteralTypeSpan(node: TemplateLiteralTypeSpan, type: TypeNode, literal: TemplateMiddle | TemplateTail): TemplateLiteralTypeSpan; + createKeywordTypeNode(kind: TKind): KeywordTypeNode; + createTypePredicateNode(assertsModifier: AssertsKeyword | undefined, parameterName: Identifier | ThisTypeNode | string, type: TypeNode | undefined): TypePredicateNode; + updateTypePredicateNode(node: TypePredicateNode, assertsModifier: AssertsKeyword | undefined, parameterName: Identifier | ThisTypeNode, type: TypeNode | undefined): TypePredicateNode; + createTypeReferenceNode(typeName: string | EntityName, typeArguments?: readonly TypeNode[]): TypeReferenceNode; + updateTypeReferenceNode(node: TypeReferenceNode, typeName: EntityName, typeArguments: NodeArray | undefined): TypeReferenceNode; + createFunctionTypeNode(typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode): FunctionTypeNode; + updateFunctionTypeNode(node: FunctionTypeNode, typeParameters: NodeArray | undefined, parameters: NodeArray, type: TypeNode): FunctionTypeNode; + createConstructorTypeNode(typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode): ConstructorTypeNode; + updateConstructorTypeNode(node: ConstructorTypeNode, typeParameters: NodeArray | undefined, parameters: NodeArray, type: TypeNode): ConstructorTypeNode; + createTypeQueryNode(exprName: EntityName): TypeQueryNode; + updateTypeQueryNode(node: TypeQueryNode, exprName: EntityName): TypeQueryNode; + createTypeLiteralNode(members: readonly TypeElement[] | undefined): TypeLiteralNode; + updateTypeLiteralNode(node: TypeLiteralNode, members: NodeArray): TypeLiteralNode; + createArrayTypeNode(elementType: TypeNode): ArrayTypeNode; + updateArrayTypeNode(node: ArrayTypeNode, elementType: TypeNode): ArrayTypeNode; + createTupleTypeNode(elements: readonly (TypeNode | NamedTupleMember)[]): TupleTypeNode; + updateTupleTypeNode(node: TupleTypeNode, elements: readonly (TypeNode | NamedTupleMember)[]): TupleTypeNode; + createNamedTupleMember(dotDotDotToken: DotDotDotToken | undefined, name: Identifier, questionToken: QuestionToken | undefined, type: TypeNode): NamedTupleMember; + updateNamedTupleMember(node: NamedTupleMember, dotDotDotToken: DotDotDotToken | undefined, name: Identifier, questionToken: QuestionToken | undefined, type: TypeNode): NamedTupleMember; + createOptionalTypeNode(type: TypeNode): OptionalTypeNode; + updateOptionalTypeNode(node: OptionalTypeNode, type: TypeNode): OptionalTypeNode; + createRestTypeNode(type: TypeNode): RestTypeNode; + updateRestTypeNode(node: RestTypeNode, type: TypeNode): RestTypeNode; + createUnionTypeNode(types: readonly TypeNode[]): UnionTypeNode; + updateUnionTypeNode(node: UnionTypeNode, types: NodeArray): UnionTypeNode; + createIntersectionTypeNode(types: readonly TypeNode[]): IntersectionTypeNode; + updateIntersectionTypeNode(node: IntersectionTypeNode, types: NodeArray): IntersectionTypeNode; + createConditionalTypeNode(checkType: TypeNode, extendsType: TypeNode, trueType: TypeNode, falseType: TypeNode): ConditionalTypeNode; + updateConditionalTypeNode(node: ConditionalTypeNode, checkType: TypeNode, extendsType: TypeNode, trueType: TypeNode, falseType: TypeNode): ConditionalTypeNode; + createInferTypeNode(typeParameter: TypeParameterDeclaration): InferTypeNode; + updateInferTypeNode(node: InferTypeNode, typeParameter: TypeParameterDeclaration): InferTypeNode; + createImportTypeNode(argument: TypeNode, qualifier?: EntityName, typeArguments?: readonly TypeNode[], isTypeOf?: boolean): ImportTypeNode; + updateImportTypeNode(node: ImportTypeNode, argument: TypeNode, qualifier: EntityName | undefined, typeArguments: readonly TypeNode[] | undefined, isTypeOf?: boolean): ImportTypeNode; + createParenthesizedType(type: TypeNode): ParenthesizedTypeNode; + updateParenthesizedType(node: ParenthesizedTypeNode, type: TypeNode): ParenthesizedTypeNode; + createThisTypeNode(): ThisTypeNode; + createTypeOperatorNode(operator: SyntaxKind.KeyOfKeyword | SyntaxKind.UniqueKeyword | SyntaxKind.ReadonlyKeyword, type: TypeNode): TypeOperatorNode; + updateTypeOperatorNode(node: TypeOperatorNode, type: TypeNode): TypeOperatorNode; + createIndexedAccessTypeNode(objectType: TypeNode, indexType: TypeNode): IndexedAccessTypeNode; + updateIndexedAccessTypeNode(node: IndexedAccessTypeNode, objectType: TypeNode, indexType: TypeNode): IndexedAccessTypeNode; + createMappedTypeNode(readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined): MappedTypeNode; + updateMappedTypeNode(node: MappedTypeNode, readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined): MappedTypeNode; + createLiteralTypeNode(literal: LiteralTypeNode["literal"]): LiteralTypeNode; + updateLiteralTypeNode(node: LiteralTypeNode, literal: LiteralTypeNode["literal"]): LiteralTypeNode; + createTemplateLiteralType(head: TemplateHead, templateSpans: readonly TemplateLiteralTypeSpan[]): TemplateLiteralTypeNode; + updateTemplateLiteralType(node: TemplateLiteralTypeNode, head: TemplateHead, templateSpans: readonly TemplateLiteralTypeSpan[]): TemplateLiteralTypeNode; + createObjectBindingPattern(elements: readonly BindingElement[]): ObjectBindingPattern; + updateObjectBindingPattern(node: ObjectBindingPattern, elements: readonly BindingElement[]): ObjectBindingPattern; + createArrayBindingPattern(elements: readonly ArrayBindingElement[]): ArrayBindingPattern; + updateArrayBindingPattern(node: ArrayBindingPattern, elements: readonly ArrayBindingElement[]): ArrayBindingPattern; + createBindingElement(dotDotDotToken: DotDotDotToken | undefined, propertyName: string | PropertyName | undefined, name: string | BindingName, initializer?: Expression): BindingElement; + updateBindingElement(node: BindingElement, dotDotDotToken: DotDotDotToken | undefined, propertyName: PropertyName | undefined, name: BindingName, initializer: Expression | undefined): BindingElement; + createArrayLiteralExpression(elements?: readonly Expression[], multiLine?: boolean): ArrayLiteralExpression; + updateArrayLiteralExpression(node: ArrayLiteralExpression, elements: readonly Expression[]): ArrayLiteralExpression; + createObjectLiteralExpression(properties?: readonly ObjectLiteralElementLike[], multiLine?: boolean): ObjectLiteralExpression; + updateObjectLiteralExpression(node: ObjectLiteralExpression, properties: readonly ObjectLiteralElementLike[]): ObjectLiteralExpression; + createPropertyAccessExpression(expression: Expression, name: string | Identifier | PrivateIdentifier): PropertyAccessExpression; + updatePropertyAccessExpression(node: PropertyAccessExpression, expression: Expression, name: Identifier | PrivateIdentifier): PropertyAccessExpression; + createPropertyAccessChain(expression: Expression, questionDotToken: QuestionDotToken | undefined, name: string | Identifier | PrivateIdentifier): PropertyAccessChain; + updatePropertyAccessChain(node: PropertyAccessChain, expression: Expression, questionDotToken: QuestionDotToken | undefined, name: Identifier | PrivateIdentifier): PropertyAccessChain; + createElementAccessExpression(expression: Expression, index: number | Expression): ElementAccessExpression; + updateElementAccessExpression(node: ElementAccessExpression, expression: Expression, argumentExpression: Expression): ElementAccessExpression; + createElementAccessChain(expression: Expression, questionDotToken: QuestionDotToken | undefined, index: number | Expression): ElementAccessChain; + updateElementAccessChain(node: ElementAccessChain, expression: Expression, questionDotToken: QuestionDotToken | undefined, argumentExpression: Expression): ElementAccessChain; + createCallExpression(expression: Expression, typeArguments: readonly TypeNode[] | undefined, argumentsArray: readonly Expression[] | undefined): CallExpression; + updateCallExpression(node: CallExpression, expression: Expression, typeArguments: readonly TypeNode[] | undefined, argumentsArray: readonly Expression[]): CallExpression; + createCallChain(expression: Expression, questionDotToken: QuestionDotToken | undefined, typeArguments: readonly TypeNode[] | undefined, argumentsArray: readonly Expression[] | undefined): CallChain; + updateCallChain(node: CallChain, expression: Expression, questionDotToken: QuestionDotToken | undefined, typeArguments: readonly TypeNode[] | undefined, argumentsArray: readonly Expression[]): CallChain; + createNewExpression(expression: Expression, typeArguments: readonly TypeNode[] | undefined, argumentsArray: readonly Expression[] | undefined): NewExpression; + updateNewExpression(node: NewExpression, expression: Expression, typeArguments: readonly TypeNode[] | undefined, argumentsArray: readonly Expression[] | undefined): NewExpression; + createTaggedTemplateExpression(tag: Expression, typeArguments: readonly TypeNode[] | undefined, template: TemplateLiteral): TaggedTemplateExpression; + updateTaggedTemplateExpression(node: TaggedTemplateExpression, tag: Expression, typeArguments: readonly TypeNode[] | undefined, template: TemplateLiteral): TaggedTemplateExpression; + createTypeAssertion(type: TypeNode, expression: Expression): TypeAssertion; + updateTypeAssertion(node: TypeAssertion, type: TypeNode, expression: Expression): TypeAssertion; + createParenthesizedExpression(expression: Expression): ParenthesizedExpression; + updateParenthesizedExpression(node: ParenthesizedExpression, expression: Expression): ParenthesizedExpression; + createFunctionExpression(modifiers: readonly Modifier[] | undefined, asteriskToken: AsteriskToken | undefined, name: string | Identifier | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[] | undefined, type: TypeNode | undefined, body: Block): FunctionExpression; + updateFunctionExpression(node: FunctionExpression, modifiers: readonly Modifier[] | undefined, asteriskToken: AsteriskToken | undefined, name: Identifier | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, body: Block): FunctionExpression; + createArrowFunction(modifiers: readonly Modifier[] | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, equalsGreaterThanToken: EqualsGreaterThanToken | undefined, body: ConciseBody): ArrowFunction; + updateArrowFunction(node: ArrowFunction, modifiers: readonly Modifier[] | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, equalsGreaterThanToken: EqualsGreaterThanToken, body: ConciseBody): ArrowFunction; + createDeleteExpression(expression: Expression): DeleteExpression; + updateDeleteExpression(node: DeleteExpression, expression: Expression): DeleteExpression; + createTypeOfExpression(expression: Expression): TypeOfExpression; + updateTypeOfExpression(node: TypeOfExpression, expression: Expression): TypeOfExpression; + createVoidExpression(expression: Expression): VoidExpression; + updateVoidExpression(node: VoidExpression, expression: Expression): VoidExpression; + createAwaitExpression(expression: Expression): AwaitExpression; + updateAwaitExpression(node: AwaitExpression, expression: Expression): AwaitExpression; + createPrefixUnaryExpression(operator: PrefixUnaryOperator, operand: Expression): PrefixUnaryExpression; + updatePrefixUnaryExpression(node: PrefixUnaryExpression, operand: Expression): PrefixUnaryExpression; + createPostfixUnaryExpression(operand: Expression, operator: PostfixUnaryOperator): PostfixUnaryExpression; + updatePostfixUnaryExpression(node: PostfixUnaryExpression, operand: Expression): PostfixUnaryExpression; + createBinaryExpression(left: Expression, operator: BinaryOperator | BinaryOperatorToken, right: Expression): BinaryExpression; + updateBinaryExpression(node: BinaryExpression, left: Expression, operator: BinaryOperator | BinaryOperatorToken, right: Expression): BinaryExpression; + createConditionalExpression(condition: Expression, questionToken: QuestionToken | undefined, whenTrue: Expression, colonToken: ColonToken | undefined, whenFalse: Expression): ConditionalExpression; + updateConditionalExpression(node: ConditionalExpression, condition: Expression, questionToken: QuestionToken, whenTrue: Expression, colonToken: ColonToken, whenFalse: Expression): ConditionalExpression; + createTemplateExpression(head: TemplateHead, templateSpans: readonly TemplateSpan[]): TemplateExpression; + updateTemplateExpression(node: TemplateExpression, head: TemplateHead, templateSpans: readonly TemplateSpan[]): TemplateExpression; + createTemplateHead(text: string, rawText?: string, templateFlags?: TokenFlags): TemplateHead; + createTemplateHead(text: string | undefined, rawText: string, templateFlags?: TokenFlags): TemplateHead; + createTemplateMiddle(text: string, rawText?: string, templateFlags?: TokenFlags): TemplateMiddle; + createTemplateMiddle(text: string | undefined, rawText: string, templateFlags?: TokenFlags): TemplateMiddle; + createTemplateTail(text: string, rawText?: string, templateFlags?: TokenFlags): TemplateTail; + createTemplateTail(text: string | undefined, rawText: string, templateFlags?: TokenFlags): TemplateTail; + createNoSubstitutionTemplateLiteral(text: string, rawText?: string): NoSubstitutionTemplateLiteral; + createNoSubstitutionTemplateLiteral(text: string | undefined, rawText: string): NoSubstitutionTemplateLiteral; + createYieldExpression(asteriskToken: AsteriskToken, expression: Expression): YieldExpression; + createYieldExpression(asteriskToken: undefined, expression: Expression | undefined): YieldExpression; + updateYieldExpression(node: YieldExpression, asteriskToken: AsteriskToken | undefined, expression: Expression | undefined): YieldExpression; + createSpreadElement(expression: Expression): SpreadElement; + updateSpreadElement(node: SpreadElement, expression: Expression): SpreadElement; + createClassExpression(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, heritageClauses: readonly HeritageClause[] | undefined, members: readonly ClassElement[]): ClassExpression; + updateClassExpression(node: ClassExpression, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: Identifier | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, heritageClauses: readonly HeritageClause[] | undefined, members: readonly ClassElement[]): ClassExpression; + createOmittedExpression(): OmittedExpression; + createExpressionWithTypeArguments(expression: Expression, typeArguments: readonly TypeNode[] | undefined): ExpressionWithTypeArguments; + updateExpressionWithTypeArguments(node: ExpressionWithTypeArguments, expression: Expression, typeArguments: readonly TypeNode[] | undefined): ExpressionWithTypeArguments; + createAsExpression(expression: Expression, type: TypeNode): AsExpression; + updateAsExpression(node: AsExpression, expression: Expression, type: TypeNode): AsExpression; + createNonNullExpression(expression: Expression): NonNullExpression; + updateNonNullExpression(node: NonNullExpression, expression: Expression): NonNullExpression; + createNonNullChain(expression: Expression): NonNullChain; + updateNonNullChain(node: NonNullChain, expression: Expression): NonNullChain; + createMetaProperty(keywordToken: MetaProperty["keywordToken"], name: Identifier): MetaProperty; + updateMetaProperty(node: MetaProperty, name: Identifier): MetaProperty; + createTemplateSpan(expression: Expression, literal: TemplateMiddle | TemplateTail): TemplateSpan; + updateTemplateSpan(node: TemplateSpan, expression: Expression, literal: TemplateMiddle | TemplateTail): TemplateSpan; + createSemicolonClassElement(): SemicolonClassElement; + createBlock(statements: readonly Statement[], multiLine?: boolean): Block; + updateBlock(node: Block, statements: readonly Statement[]): Block; + createVariableStatement(modifiers: readonly Modifier[] | undefined, declarationList: VariableDeclarationList | readonly VariableDeclaration[]): VariableStatement; + updateVariableStatement(node: VariableStatement, modifiers: readonly Modifier[] | undefined, declarationList: VariableDeclarationList): VariableStatement; + createEmptyStatement(): EmptyStatement; + createExpressionStatement(expression: Expression): ExpressionStatement; + updateExpressionStatement(node: ExpressionStatement, expression: Expression): ExpressionStatement; + createIfStatement(expression: Expression, thenStatement: Statement, elseStatement?: Statement): IfStatement; + updateIfStatement(node: IfStatement, expression: Expression, thenStatement: Statement, elseStatement: Statement | undefined): IfStatement; + createDoStatement(statement: Statement, expression: Expression): DoStatement; + updateDoStatement(node: DoStatement, statement: Statement, expression: Expression): DoStatement; + createWhileStatement(expression: Expression, statement: Statement): WhileStatement; + updateWhileStatement(node: WhileStatement, expression: Expression, statement: Statement): WhileStatement; + createForStatement(initializer: ForInitializer | undefined, condition: Expression | undefined, incrementor: Expression | undefined, statement: Statement): ForStatement; + updateForStatement(node: ForStatement, initializer: ForInitializer | undefined, condition: Expression | undefined, incrementor: Expression | undefined, statement: Statement): ForStatement; + createForInStatement(initializer: ForInitializer, expression: Expression, statement: Statement): ForInStatement; + updateForInStatement(node: ForInStatement, initializer: ForInitializer, expression: Expression, statement: Statement): ForInStatement; + createForOfStatement(awaitModifier: AwaitKeyword | undefined, initializer: ForInitializer, expression: Expression, statement: Statement): ForOfStatement; + updateForOfStatement(node: ForOfStatement, awaitModifier: AwaitKeyword | undefined, initializer: ForInitializer, expression: Expression, statement: Statement): ForOfStatement; + createContinueStatement(label?: string | Identifier): ContinueStatement; + updateContinueStatement(node: ContinueStatement, label: Identifier | undefined): ContinueStatement; + createBreakStatement(label?: string | Identifier): BreakStatement; + updateBreakStatement(node: BreakStatement, label: Identifier | undefined): BreakStatement; + createReturnStatement(expression?: Expression): ReturnStatement; + updateReturnStatement(node: ReturnStatement, expression: Expression | undefined): ReturnStatement; + createWithStatement(expression: Expression, statement: Statement): WithStatement; + updateWithStatement(node: WithStatement, expression: Expression, statement: Statement): WithStatement; + createSwitchStatement(expression: Expression, caseBlock: CaseBlock): SwitchStatement; + updateSwitchStatement(node: SwitchStatement, expression: Expression, caseBlock: CaseBlock): SwitchStatement; + createLabeledStatement(label: string | Identifier, statement: Statement): LabeledStatement; + updateLabeledStatement(node: LabeledStatement, label: Identifier, statement: Statement): LabeledStatement; + createThrowStatement(expression: Expression): ThrowStatement; + updateThrowStatement(node: ThrowStatement, expression: Expression): ThrowStatement; + createTryStatement(tryBlock: Block, catchClause: CatchClause | undefined, finallyBlock: Block | undefined): TryStatement; + updateTryStatement(node: TryStatement, tryBlock: Block, catchClause: CatchClause | undefined, finallyBlock: Block | undefined): TryStatement; + createDebuggerStatement(): DebuggerStatement; + createVariableDeclaration(name: string | BindingName, exclamationToken?: ExclamationToken, type?: TypeNode, initializer?: Expression): VariableDeclaration; + updateVariableDeclaration(node: VariableDeclaration, name: BindingName, exclamationToken: ExclamationToken | undefined, type: TypeNode | undefined, initializer: Expression | undefined): VariableDeclaration; + createVariableDeclarationList(declarations: readonly VariableDeclaration[], flags?: NodeFlags): VariableDeclarationList; + updateVariableDeclarationList(node: VariableDeclarationList, declarations: readonly VariableDeclaration[]): VariableDeclarationList; + createFunctionDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, asteriskToken: AsteriskToken | undefined, name: string | Identifier | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, body: Block | undefined): FunctionDeclaration; + updateFunctionDeclaration(node: FunctionDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, asteriskToken: AsteriskToken | undefined, name: Identifier | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, body: Block | undefined): FunctionDeclaration; + createClassDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, heritageClauses: readonly HeritageClause[] | undefined, members: readonly ClassElement[]): ClassDeclaration; + updateClassDeclaration(node: ClassDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: Identifier | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, heritageClauses: readonly HeritageClause[] | undefined, members: readonly ClassElement[]): ClassDeclaration; + createInterfaceDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier, typeParameters: readonly TypeParameterDeclaration[] | undefined, heritageClauses: readonly HeritageClause[] | undefined, members: readonly TypeElement[]): InterfaceDeclaration; + updateInterfaceDeclaration(node: InterfaceDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: Identifier, typeParameters: readonly TypeParameterDeclaration[] | undefined, heritageClauses: readonly HeritageClause[] | undefined, members: readonly TypeElement[]): InterfaceDeclaration; + createTypeAliasDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier, typeParameters: readonly TypeParameterDeclaration[] | undefined, type: TypeNode): TypeAliasDeclaration; + updateTypeAliasDeclaration(node: TypeAliasDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: Identifier, typeParameters: readonly TypeParameterDeclaration[] | undefined, type: TypeNode): TypeAliasDeclaration; + createEnumDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier, members: readonly EnumMember[]): EnumDeclaration; + updateEnumDeclaration(node: EnumDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: Identifier, members: readonly EnumMember[]): EnumDeclaration; + createModuleDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: ModuleName, body: ModuleBody | undefined, flags?: NodeFlags): ModuleDeclaration; + updateModuleDeclaration(node: ModuleDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: ModuleName, body: ModuleBody | undefined): ModuleDeclaration; + createModuleBlock(statements: readonly Statement[]): ModuleBlock; + updateModuleBlock(node: ModuleBlock, statements: readonly Statement[]): ModuleBlock; + createCaseBlock(clauses: readonly CaseOrDefaultClause[]): CaseBlock; + updateCaseBlock(node: CaseBlock, clauses: readonly CaseOrDefaultClause[]): CaseBlock; + createNamespaceExportDeclaration(name: string | Identifier): NamespaceExportDeclaration; + updateNamespaceExportDeclaration(node: NamespaceExportDeclaration, name: Identifier): NamespaceExportDeclaration; + createImportEqualsDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier, moduleReference: ModuleReference): ImportEqualsDeclaration; + updateImportEqualsDeclaration(node: ImportEqualsDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: Identifier, moduleReference: ModuleReference): ImportEqualsDeclaration; + createImportDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, importClause: ImportClause | undefined, moduleSpecifier: Expression): ImportDeclaration; + updateImportDeclaration(node: ImportDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, importClause: ImportClause | undefined, moduleSpecifier: Expression): ImportDeclaration; + createImportClause(isTypeOnly: boolean, name: Identifier | undefined, namedBindings: NamedImportBindings | undefined): ImportClause; + updateImportClause(node: ImportClause, isTypeOnly: boolean, name: Identifier | undefined, namedBindings: NamedImportBindings | undefined): ImportClause; + createNamespaceImport(name: Identifier): NamespaceImport; + updateNamespaceImport(node: NamespaceImport, name: Identifier): NamespaceImport; + createNamespaceExport(name: Identifier): NamespaceExport; + updateNamespaceExport(node: NamespaceExport, name: Identifier): NamespaceExport; + createNamedImports(elements: readonly ImportSpecifier[]): NamedImports; + updateNamedImports(node: NamedImports, elements: readonly ImportSpecifier[]): NamedImports; + createImportSpecifier(propertyName: Identifier | undefined, name: Identifier): ImportSpecifier; + updateImportSpecifier(node: ImportSpecifier, propertyName: Identifier | undefined, name: Identifier): ImportSpecifier; + createExportAssignment(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, isExportEquals: boolean | undefined, expression: Expression): ExportAssignment; + updateExportAssignment(node: ExportAssignment, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, expression: Expression): ExportAssignment; + createExportDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, isTypeOnly: boolean, exportClause: NamedExportBindings | undefined, moduleSpecifier?: Expression): ExportDeclaration; + updateExportDeclaration(node: ExportDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, isTypeOnly: boolean, exportClause: NamedExportBindings | undefined, moduleSpecifier: Expression | undefined): ExportDeclaration; + createNamedExports(elements: readonly ExportSpecifier[]): NamedExports; + updateNamedExports(node: NamedExports, elements: readonly ExportSpecifier[]): NamedExports; + createExportSpecifier(propertyName: string | Identifier | undefined, name: string | Identifier): ExportSpecifier; + updateExportSpecifier(node: ExportSpecifier, propertyName: Identifier | undefined, name: Identifier): ExportSpecifier; + createExternalModuleReference(expression: Expression): ExternalModuleReference; + updateExternalModuleReference(node: ExternalModuleReference, expression: Expression): ExternalModuleReference; + createJSDocAllType(): JSDocAllType; + createJSDocUnknownType(): JSDocUnknownType; + createJSDocNonNullableType(type: TypeNode): JSDocNonNullableType; + updateJSDocNonNullableType(node: JSDocNonNullableType, type: TypeNode): JSDocNonNullableType; + createJSDocNullableType(type: TypeNode): JSDocNullableType; + updateJSDocNullableType(node: JSDocNullableType, type: TypeNode): JSDocNullableType; + createJSDocOptionalType(type: TypeNode): JSDocOptionalType; + updateJSDocOptionalType(node: JSDocOptionalType, type: TypeNode): JSDocOptionalType; + createJSDocFunctionType(parameters: readonly ParameterDeclaration[], type: TypeNode | undefined): JSDocFunctionType; + updateJSDocFunctionType(node: JSDocFunctionType, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined): JSDocFunctionType; + createJSDocVariadicType(type: TypeNode): JSDocVariadicType; + updateJSDocVariadicType(node: JSDocVariadicType, type: TypeNode): JSDocVariadicType; + createJSDocNamepathType(type: TypeNode): JSDocNamepathType; + updateJSDocNamepathType(node: JSDocNamepathType, type: TypeNode): JSDocNamepathType; + createJSDocTypeExpression(type: TypeNode): JSDocTypeExpression; + updateJSDocTypeExpression(node: JSDocTypeExpression, type: TypeNode): JSDocTypeExpression; + createJSDocNameReference(name: EntityName): JSDocNameReference; + updateJSDocNameReference(node: JSDocNameReference, name: EntityName): JSDocNameReference; + createJSDocTypeLiteral(jsDocPropertyTags?: readonly JSDocPropertyLikeTag[], isArrayType?: boolean): JSDocTypeLiteral; + updateJSDocTypeLiteral(node: JSDocTypeLiteral, jsDocPropertyTags: readonly JSDocPropertyLikeTag[] | undefined, isArrayType: boolean | undefined): JSDocTypeLiteral; + createJSDocSignature(typeParameters: readonly JSDocTemplateTag[] | undefined, parameters: readonly JSDocParameterTag[], type?: JSDocReturnTag): JSDocSignature; + updateJSDocSignature(node: JSDocSignature, typeParameters: readonly JSDocTemplateTag[] | undefined, parameters: readonly JSDocParameterTag[], type: JSDocReturnTag | undefined): JSDocSignature; + createJSDocTemplateTag(tagName: Identifier | undefined, constraint: JSDocTypeExpression | undefined, typeParameters: readonly TypeParameterDeclaration[], comment?: string): JSDocTemplateTag; + updateJSDocTemplateTag(node: JSDocTemplateTag, tagName: Identifier | undefined, constraint: JSDocTypeExpression | undefined, typeParameters: readonly TypeParameterDeclaration[], comment: string | undefined): JSDocTemplateTag; + createJSDocTypedefTag(tagName: Identifier | undefined, typeExpression?: JSDocTypeExpression | JSDocTypeLiteral, fullName?: Identifier | JSDocNamespaceDeclaration, comment?: string): JSDocTypedefTag; + updateJSDocTypedefTag(node: JSDocTypedefTag, tagName: Identifier | undefined, typeExpression: JSDocTypeExpression | JSDocTypeLiteral | undefined, fullName: Identifier | JSDocNamespaceDeclaration | undefined, comment: string | undefined): JSDocTypedefTag; + createJSDocParameterTag(tagName: Identifier | undefined, name: EntityName, isBracketed: boolean, typeExpression?: JSDocTypeExpression, isNameFirst?: boolean, comment?: string): JSDocParameterTag; + updateJSDocParameterTag(node: JSDocParameterTag, tagName: Identifier | undefined, name: EntityName, isBracketed: boolean, typeExpression: JSDocTypeExpression | undefined, isNameFirst: boolean, comment: string | undefined): JSDocParameterTag; + createJSDocPropertyTag(tagName: Identifier | undefined, name: EntityName, isBracketed: boolean, typeExpression?: JSDocTypeExpression, isNameFirst?: boolean, comment?: string): JSDocPropertyTag; + updateJSDocPropertyTag(node: JSDocPropertyTag, tagName: Identifier | undefined, name: EntityName, isBracketed: boolean, typeExpression: JSDocTypeExpression | undefined, isNameFirst: boolean, comment: string | undefined): JSDocPropertyTag; + createJSDocTypeTag(tagName: Identifier | undefined, typeExpression: JSDocTypeExpression, comment?: string): JSDocTypeTag; + updateJSDocTypeTag(node: JSDocTypeTag, tagName: Identifier | undefined, typeExpression: JSDocTypeExpression, comment: string | undefined): JSDocTypeTag; + createJSDocSeeTag(tagName: Identifier | undefined, nameExpression: JSDocNameReference | undefined, comment?: string): JSDocSeeTag; + updateJSDocSeeTag(node: JSDocSeeTag, tagName: Identifier | undefined, nameExpression: JSDocNameReference | undefined, comment?: string): JSDocSeeTag; + createJSDocReturnTag(tagName: Identifier | undefined, typeExpression?: JSDocTypeExpression, comment?: string): JSDocReturnTag; + updateJSDocReturnTag(node: JSDocReturnTag, tagName: Identifier | undefined, typeExpression: JSDocTypeExpression | undefined, comment: string | undefined): JSDocReturnTag; + createJSDocThisTag(tagName: Identifier | undefined, typeExpression: JSDocTypeExpression, comment?: string): JSDocThisTag; + updateJSDocThisTag(node: JSDocThisTag, tagName: Identifier | undefined, typeExpression: JSDocTypeExpression | undefined, comment: string | undefined): JSDocThisTag; + createJSDocEnumTag(tagName: Identifier | undefined, typeExpression: JSDocTypeExpression, comment?: string): JSDocEnumTag; + updateJSDocEnumTag(node: JSDocEnumTag, tagName: Identifier | undefined, typeExpression: JSDocTypeExpression, comment: string | undefined): JSDocEnumTag; + createJSDocCallbackTag(tagName: Identifier | undefined, typeExpression: JSDocSignature, fullName?: Identifier | JSDocNamespaceDeclaration, comment?: string): JSDocCallbackTag; + updateJSDocCallbackTag(node: JSDocCallbackTag, tagName: Identifier | undefined, typeExpression: JSDocSignature, fullName: Identifier | JSDocNamespaceDeclaration | undefined, comment: string | undefined): JSDocCallbackTag; + createJSDocAugmentsTag(tagName: Identifier | undefined, className: JSDocAugmentsTag["class"], comment?: string): JSDocAugmentsTag; + updateJSDocAugmentsTag(node: JSDocAugmentsTag, tagName: Identifier | undefined, className: JSDocAugmentsTag["class"], comment: string | undefined): JSDocAugmentsTag; + createJSDocImplementsTag(tagName: Identifier | undefined, className: JSDocImplementsTag["class"], comment?: string): JSDocImplementsTag; + updateJSDocImplementsTag(node: JSDocImplementsTag, tagName: Identifier | undefined, className: JSDocImplementsTag["class"], comment: string | undefined): JSDocImplementsTag; + createJSDocAuthorTag(tagName: Identifier | undefined, comment?: string): JSDocAuthorTag; + updateJSDocAuthorTag(node: JSDocAuthorTag, tagName: Identifier | undefined, comment: string | undefined): JSDocAuthorTag; + createJSDocClassTag(tagName: Identifier | undefined, comment?: string): JSDocClassTag; + updateJSDocClassTag(node: JSDocClassTag, tagName: Identifier | undefined, comment: string | undefined): JSDocClassTag; + createJSDocPublicTag(tagName: Identifier | undefined, comment?: string): JSDocPublicTag; + updateJSDocPublicTag(node: JSDocPublicTag, tagName: Identifier | undefined, comment: string | undefined): JSDocPublicTag; + createJSDocPrivateTag(tagName: Identifier | undefined, comment?: string): JSDocPrivateTag; + updateJSDocPrivateTag(node: JSDocPrivateTag, tagName: Identifier | undefined, comment: string | undefined): JSDocPrivateTag; + createJSDocProtectedTag(tagName: Identifier | undefined, comment?: string): JSDocProtectedTag; + updateJSDocProtectedTag(node: JSDocProtectedTag, tagName: Identifier | undefined, comment: string | undefined): JSDocProtectedTag; + createJSDocReadonlyTag(tagName: Identifier | undefined, comment?: string): JSDocReadonlyTag; + updateJSDocReadonlyTag(node: JSDocReadonlyTag, tagName: Identifier | undefined, comment: string | undefined): JSDocReadonlyTag; + createJSDocUnknownTag(tagName: Identifier, comment?: string): JSDocUnknownTag; + updateJSDocUnknownTag(node: JSDocUnknownTag, tagName: Identifier, comment: string | undefined): JSDocUnknownTag; + createJSDocDeprecatedTag(tagName: Identifier, comment?: string): JSDocDeprecatedTag; + updateJSDocDeprecatedTag(node: JSDocDeprecatedTag, tagName: Identifier, comment?: string): JSDocDeprecatedTag; + createJSDocComment(comment?: string | undefined, tags?: readonly JSDocTag[] | undefined): JSDoc; + updateJSDocComment(node: JSDoc, comment: string | undefined, tags: readonly JSDocTag[] | undefined): JSDoc; + createJsxElement(openingElement: JsxOpeningElement, children: readonly JsxChild[], closingElement: JsxClosingElement): JsxElement; + updateJsxElement(node: JsxElement, openingElement: JsxOpeningElement, children: readonly JsxChild[], closingElement: JsxClosingElement): JsxElement; + createJsxSelfClosingElement(tagName: JsxTagNameExpression, typeArguments: readonly TypeNode[] | undefined, attributes: JsxAttributes): JsxSelfClosingElement; + updateJsxSelfClosingElement(node: JsxSelfClosingElement, tagName: JsxTagNameExpression, typeArguments: readonly TypeNode[] | undefined, attributes: JsxAttributes): JsxSelfClosingElement; + createJsxOpeningElement(tagName: JsxTagNameExpression, typeArguments: readonly TypeNode[] | undefined, attributes: JsxAttributes): JsxOpeningElement; + updateJsxOpeningElement(node: JsxOpeningElement, tagName: JsxTagNameExpression, typeArguments: readonly TypeNode[] | undefined, attributes: JsxAttributes): JsxOpeningElement; + createJsxClosingElement(tagName: JsxTagNameExpression): JsxClosingElement; + updateJsxClosingElement(node: JsxClosingElement, tagName: JsxTagNameExpression): JsxClosingElement; + createJsxFragment(openingFragment: JsxOpeningFragment, children: readonly JsxChild[], closingFragment: JsxClosingFragment): JsxFragment; + createJsxText(text: string, containsOnlyTriviaWhiteSpaces?: boolean): JsxText; + updateJsxText(node: JsxText, text: string, containsOnlyTriviaWhiteSpaces?: boolean): JsxText; + createJsxOpeningFragment(): JsxOpeningFragment; + createJsxJsxClosingFragment(): JsxClosingFragment; + updateJsxFragment(node: JsxFragment, openingFragment: JsxOpeningFragment, children: readonly JsxChild[], closingFragment: JsxClosingFragment): JsxFragment; + createJsxAttribute(name: Identifier, initializer: StringLiteral | JsxExpression | undefined): JsxAttribute; + updateJsxAttribute(node: JsxAttribute, name: Identifier, initializer: StringLiteral | JsxExpression | undefined): JsxAttribute; + createJsxAttributes(properties: readonly JsxAttributeLike[]): JsxAttributes; + updateJsxAttributes(node: JsxAttributes, properties: readonly JsxAttributeLike[]): JsxAttributes; + createJsxSpreadAttribute(expression: Expression): JsxSpreadAttribute; + updateJsxSpreadAttribute(node: JsxSpreadAttribute, expression: Expression): JsxSpreadAttribute; + createJsxExpression(dotDotDotToken: DotDotDotToken | undefined, expression: Expression | undefined): JsxExpression; + updateJsxExpression(node: JsxExpression, expression: Expression | undefined): JsxExpression; + createCaseClause(expression: Expression, statements: readonly Statement[]): CaseClause; + updateCaseClause(node: CaseClause, expression: Expression, statements: readonly Statement[]): CaseClause; + createDefaultClause(statements: readonly Statement[]): DefaultClause; + updateDefaultClause(node: DefaultClause, statements: readonly Statement[]): DefaultClause; + createHeritageClause(token: HeritageClause["token"], types: readonly ExpressionWithTypeArguments[]): HeritageClause; + updateHeritageClause(node: HeritageClause, types: readonly ExpressionWithTypeArguments[]): HeritageClause; + createCatchClause(variableDeclaration: string | VariableDeclaration | undefined, block: Block): CatchClause; + updateCatchClause(node: CatchClause, variableDeclaration: VariableDeclaration | undefined, block: Block): CatchClause; + createPropertyAssignment(name: string | PropertyName, initializer: Expression): PropertyAssignment; + updatePropertyAssignment(node: PropertyAssignment, name: PropertyName, initializer: Expression): PropertyAssignment; + createShorthandPropertyAssignment(name: string | Identifier, objectAssignmentInitializer?: Expression): ShorthandPropertyAssignment; + updateShorthandPropertyAssignment(node: ShorthandPropertyAssignment, name: Identifier, objectAssignmentInitializer: Expression | undefined): ShorthandPropertyAssignment; + createSpreadAssignment(expression: Expression): SpreadAssignment; + updateSpreadAssignment(node: SpreadAssignment, expression: Expression): SpreadAssignment; + createEnumMember(name: string | PropertyName, initializer?: Expression): EnumMember; + updateEnumMember(node: EnumMember, name: PropertyName, initializer: Expression | undefined): EnumMember; + createSourceFile(statements: readonly Statement[], endOfFileToken: EndOfFileToken, flags: NodeFlags): SourceFile; + updateSourceFile(node: SourceFile, statements: readonly Statement[], isDeclarationFile?: boolean, referencedFiles?: readonly FileReference[], typeReferences?: readonly FileReference[], hasNoDefaultLib?: boolean, libReferences?: readonly FileReference[]): SourceFile; + createNotEmittedStatement(original: Node): NotEmittedStatement; + createPartiallyEmittedExpression(expression: Expression, original?: Node): PartiallyEmittedExpression; + updatePartiallyEmittedExpression(node: PartiallyEmittedExpression, expression: Expression): PartiallyEmittedExpression; + createCommaListExpression(elements: readonly Expression[]): CommaListExpression; + updateCommaListExpression(node: CommaListExpression, elements: readonly Expression[]): CommaListExpression; + createBundle(sourceFiles: readonly SourceFile[], prepends?: readonly (UnparsedSource | InputFiles)[]): Bundle; + updateBundle(node: Bundle, sourceFiles: readonly SourceFile[], prepends?: readonly (UnparsedSource | InputFiles)[]): Bundle; + createComma(left: Expression, right: Expression): BinaryExpression; + createAssignment(left: ObjectLiteralExpression | ArrayLiteralExpression, right: Expression): DestructuringAssignment; + createAssignment(left: Expression, right: Expression): AssignmentExpression; + createLogicalOr(left: Expression, right: Expression): BinaryExpression; + createLogicalAnd(left: Expression, right: Expression): BinaryExpression; + createBitwiseOr(left: Expression, right: Expression): BinaryExpression; + createBitwiseXor(left: Expression, right: Expression): BinaryExpression; + createBitwiseAnd(left: Expression, right: Expression): BinaryExpression; + createStrictEquality(left: Expression, right: Expression): BinaryExpression; + createStrictInequality(left: Expression, right: Expression): BinaryExpression; + createEquality(left: Expression, right: Expression): BinaryExpression; + createInequality(left: Expression, right: Expression): BinaryExpression; + createLessThan(left: Expression, right: Expression): BinaryExpression; + createLessThanEquals(left: Expression, right: Expression): BinaryExpression; + createGreaterThan(left: Expression, right: Expression): BinaryExpression; + createGreaterThanEquals(left: Expression, right: Expression): BinaryExpression; + createLeftShift(left: Expression, right: Expression): BinaryExpression; + createRightShift(left: Expression, right: Expression): BinaryExpression; + createUnsignedRightShift(left: Expression, right: Expression): BinaryExpression; + createAdd(left: Expression, right: Expression): BinaryExpression; + createSubtract(left: Expression, right: Expression): BinaryExpression; + createMultiply(left: Expression, right: Expression): BinaryExpression; + createDivide(left: Expression, right: Expression): BinaryExpression; + createModulo(left: Expression, right: Expression): BinaryExpression; + createExponent(left: Expression, right: Expression): BinaryExpression; + createPrefixPlus(operand: Expression): PrefixUnaryExpression; + createPrefixMinus(operand: Expression): PrefixUnaryExpression; + createPrefixIncrement(operand: Expression): PrefixUnaryExpression; + createPrefixDecrement(operand: Expression): PrefixUnaryExpression; + createBitwiseNot(operand: Expression): PrefixUnaryExpression; + createLogicalNot(operand: Expression): PrefixUnaryExpression; + createPostfixIncrement(operand: Expression): PostfixUnaryExpression; + createPostfixDecrement(operand: Expression): PostfixUnaryExpression; + createImmediatelyInvokedFunctionExpression(statements: readonly Statement[]): CallExpression; + createImmediatelyInvokedFunctionExpression(statements: readonly Statement[], param: ParameterDeclaration, paramValue: Expression): CallExpression; + createImmediatelyInvokedArrowFunction(statements: readonly Statement[]): CallExpression; + createImmediatelyInvokedArrowFunction(statements: readonly Statement[], param: ParameterDeclaration, paramValue: Expression): CallExpression; + createVoidZero(): VoidExpression; + createExportDefault(expression: Expression): ExportAssignment; + createExternalModuleExport(exportName: Identifier): ExportDeclaration; + restoreOuterExpressions(outerExpression: Expression | undefined, innerExpression: Expression, kinds?: OuterExpressionKinds): Expression; + } + export interface CoreTransformationContext { + readonly factory: NodeFactory; + /** Gets the compiler options supplied to the transformer. */ + getCompilerOptions(): CompilerOptions; + /** Starts a new lexical environment. */ + startLexicalEnvironment(): void; + /** Suspends the current lexical environment, usually after visiting a parameter list. */ + suspendLexicalEnvironment(): void; + /** Resumes a suspended lexical environment, usually before visiting a function body. */ + resumeLexicalEnvironment(): void; + /** Ends a lexical environment, returning any declarations. */ + endLexicalEnvironment(): Statement[] | undefined; + /** Hoists a function declaration to the containing scope. */ + hoistFunctionDeclaration(node: FunctionDeclaration): void; + /** Hoists a variable declaration to the containing scope. */ + hoistVariableDeclaration(node: Identifier): void; + } + export interface TransformationContext extends CoreTransformationContext { + /** Records a request for a non-scoped emit helper in the current context. */ + requestEmitHelper(helper: EmitHelper): void; + /** Gets and resets the requested non-scoped emit helpers. */ + readEmitHelpers(): EmitHelper[] | undefined; + /** Enables expression substitutions in the pretty printer for the provided SyntaxKind. */ + enableSubstitution(kind: SyntaxKind): void; + /** Determines whether expression substitutions are enabled for the provided node. */ + isSubstitutionEnabled(node: Node): boolean; + /** + * Hook used by transformers to substitute expressions just before they + * are emitted by the pretty printer. + * + * NOTE: Transformation hooks should only be modified during `Transformer` initialization, + * before returning the `NodeTransformer` callback. + */ + onSubstituteNode: (hint: EmitHint, node: Node) => Node; + /** + * Enables before/after emit notifications in the pretty printer for the provided + * SyntaxKind. + */ + enableEmitNotification(kind: SyntaxKind): void; + /** + * Determines whether before/after emit notifications should be raised in the pretty + * printer when it emits a node. + */ + isEmitNotificationEnabled(node: Node): boolean; + /** + * Hook used to allow transformers to capture state before or after + * the printer emits a node. + * + * NOTE: Transformation hooks should only be modified during `Transformer` initialization, + * before returning the `NodeTransformer` callback. + */ + onEmitNode: (hint: EmitHint, node: Node, emitCallback: (hint: EmitHint, node: Node) => void) => void; + } + export interface TransformationResult { + /** Gets the transformed source files. */ + transformed: T[]; + /** Gets diagnostics for the transformation. */ + diagnostics?: DiagnosticWithLocation[]; + /** + * Gets a substitute for a node, if one is available; otherwise, returns the original node. + * + * @param hint A hint as to the intended usage of the node. + * @param node The node to substitute. + */ + substituteNode(hint: EmitHint, node: Node): Node; + /** + * Emits a node with possible notification. + * + * @param hint A hint as to the intended usage of the node. + * @param node The node to emit. + * @param emitCallback A callback used to emit the node. + */ + emitNodeWithNotification(hint: EmitHint, node: Node, emitCallback: (hint: EmitHint, node: Node) => void): void; + /** + * Indicates if a given node needs an emit notification + * + * @param node The node to emit. + */ + isEmitNotificationEnabled?(node: Node): boolean; + /** + * Clean up EmitNode entries on any parse-tree nodes. + */ + dispose(): void; + } + /** + * A function that is used to initialize and return a `Transformer` callback, which in turn + * will be used to transform one or more nodes. + */ + export type TransformerFactory = (context: TransformationContext) => Transformer; + /** + * A function that transforms a node. + */ + export type Transformer = (node: T) => T; + /** + * A function that accepts and possibly transforms a node. + */ + export type Visitor = (node: Node) => VisitResult; + export interface NodeVisitor { + (nodes: T, visitor: Visitor | undefined, test?: (node: Node) => boolean, lift?: (node: NodeArray) => T): T; + (nodes: T | undefined, visitor: Visitor | undefined, test?: (node: Node) => boolean, lift?: (node: NodeArray) => T): T | undefined; + } + export interface NodesVisitor { + (nodes: NodeArray, visitor: Visitor | undefined, test?: (node: Node) => boolean, start?: number, count?: number): NodeArray; + (nodes: NodeArray | undefined, visitor: Visitor | undefined, test?: (node: Node) => boolean, start?: number, count?: number): NodeArray | undefined; + } + export type VisitResult = T | T[] | undefined; + export interface Printer { + /** + * Print a node and its subtree as-is, without any emit transformations. + * @param hint A value indicating the purpose of a node. This is primarily used to + * distinguish between an `Identifier` used in an expression position, versus an + * `Identifier` used as an `IdentifierName` as part of a declaration. For most nodes you + * should just pass `Unspecified`. + * @param node The node to print. The node and its subtree are printed as-is, without any + * emit transformations. + * @param sourceFile A source file that provides context for the node. The source text of + * the file is used to emit the original source content for literals and identifiers, while + * the identifiers of the source file are used when generating unique names to avoid + * collisions. + */ + printNode(hint: EmitHint, node: Node, sourceFile: SourceFile): string; + /** + * Prints a list of nodes using the given format flags + */ + printList(format: ListFormat, list: NodeArray, sourceFile: SourceFile): string; + /** + * Prints a source file as-is, without any emit transformations. + */ + printFile(sourceFile: SourceFile): string; + /** + * Prints a bundle of source files as-is, without any emit transformations. + */ + printBundle(bundle: Bundle): string; + } + export interface PrintHandlers { + /** + * A hook used by the Printer when generating unique names to avoid collisions with + * globally defined names that exist outside of the current source file. + */ + hasGlobalName?(name: string): boolean; + /** + * A hook used by the Printer to provide notifications prior to emitting a node. A + * compatible implementation **must** invoke `emitCallback` with the provided `hint` and + * `node` values. + * @param hint A hint indicating the intended purpose of the node. + * @param node The node to emit. + * @param emitCallback A callback that, when invoked, will emit the node. + * @example + * ```ts + * var printer = createPrinter(printerOptions, { + * onEmitNode(hint, node, emitCallback) { + * // set up or track state prior to emitting the node... + * emitCallback(hint, node); + * // restore state after emitting the node... + * } + * }); + * ``` + */ + onEmitNode?(hint: EmitHint, node: Node | undefined, emitCallback: (hint: EmitHint, node: Node | undefined) => void): void; + /** + * A hook used to check if an emit notification is required for a node. + * @param node The node to emit. + */ + isEmitNotificationEnabled?(node: Node | undefined): boolean; + /** + * A hook used by the Printer to perform just-in-time substitution of a node. This is + * primarily used by node transformations that need to substitute one node for another, + * such as replacing `myExportedVar` with `exports.myExportedVar`. + * @param hint A hint indicating the intended purpose of the node. + * @param node The node to emit. + * @example + * ```ts + * var printer = createPrinter(printerOptions, { + * substituteNode(hint, node) { + * // perform substitution if necessary... + * return node; + * } + * }); + * ``` + */ + substituteNode?(hint: EmitHint, node: Node): Node; + } + export interface PrinterOptions { + removeComments?: boolean; + newLine?: NewLineKind; + omitTrailingSemicolon?: boolean; + noEmitHelpers?: boolean; + } + export interface GetEffectiveTypeRootsHost { + directoryExists?(directoryName: string): boolean; + getCurrentDirectory?(): string; + } + export interface TextSpan { + start: number; + length: number; + } + export interface TextChangeRange { + span: TextSpan; + newLength: number; + } + export interface SyntaxList extends Node { + kind: SyntaxKind.SyntaxList; + _children: Node[]; + } + export enum ListFormat { + None = 0, + SingleLine = 0, + MultiLine = 1, + PreserveLines = 2, + LinesMask = 3, + NotDelimited = 0, + BarDelimited = 4, + AmpersandDelimited = 8, + CommaDelimited = 16, + AsteriskDelimited = 32, + DelimitersMask = 60, + AllowTrailingComma = 64, + Indented = 128, + SpaceBetweenBraces = 256, + SpaceBetweenSiblings = 512, + Braces = 1024, + Parenthesis = 2048, + AngleBrackets = 4096, + SquareBrackets = 8192, + BracketsMask = 15360, + OptionalIfUndefined = 16384, + OptionalIfEmpty = 32768, + Optional = 49152, + PreferNewLine = 65536, + NoTrailingNewLine = 131072, + NoInterveningComments = 262144, + NoSpaceIfEmpty = 524288, + SingleElement = 1048576, + SpaceAfterList = 2097152, + Modifiers = 262656, + HeritageClauses = 512, + SingleLineTypeLiteralMembers = 768, + MultiLineTypeLiteralMembers = 32897, + SingleLineTupleTypeElements = 528, + MultiLineTupleTypeElements = 657, + UnionTypeConstituents = 516, + IntersectionTypeConstituents = 520, + ObjectBindingPatternElements = 525136, + ArrayBindingPatternElements = 524880, + ObjectLiteralExpressionProperties = 526226, + ArrayLiteralExpressionElements = 8914, + CommaListElements = 528, + CallExpressionArguments = 2576, + NewExpressionArguments = 18960, + TemplateExpressionSpans = 262144, + SingleLineBlockStatements = 768, + MultiLineBlockStatements = 129, + VariableDeclarationList = 528, + SingleLineFunctionBodyStatements = 768, + MultiLineFunctionBodyStatements = 1, + ClassHeritageClauses = 0, + ClassMembers = 129, + InterfaceMembers = 129, + EnumMembers = 145, + CaseBlockClauses = 129, + NamedImportsOrExportsElements = 525136, + JsxElementOrFragmentChildren = 262144, + JsxElementAttributes = 262656, + CaseOrDefaultClauseStatements = 163969, + HeritageClauseTypes = 528, + SourceFileStatements = 131073, + Decorators = 2146305, + TypeArguments = 53776, + TypeParameters = 53776, + Parameters = 2576, + IndexSignatureParameters = 8848, + JSDocComment = 33 + } + export interface UserPreferences { + readonly disableSuggestions?: boolean; + readonly quotePreference?: "auto" | "double" | "single"; + readonly includeCompletionsForModuleExports?: boolean; + readonly includeAutomaticOptionalChainCompletions?: boolean; + readonly includeCompletionsWithInsertText?: boolean; + readonly importModuleSpecifierPreference?: "auto" | "relative" | "non-relative"; + /** Determines whether we import `foo/index.ts` as "foo", "foo/index", or "foo/index.js" */ + readonly importModuleSpecifierEnding?: "auto" | "minimal" | "index" | "js"; + readonly allowTextChangesInNewFiles?: boolean; + readonly providePrefixAndSuffixTextForRename?: boolean; + readonly includePackageJsonAutoImports?: "auto" | "on" | "off"; + readonly provideRefactorNotApplicableReason?: boolean; + } + /** Represents a bigint literal value without requiring bigint support */ + export interface PseudoBigInt { + negative: boolean; + base10Value: string; + } + export {}; +} +declare function setTimeout(handler: (...args: any[]) => void, timeout: number): any; +declare function clearTimeout(handle: any): void; +declare namespace ts { + export enum FileWatcherEventKind { + Created = 0, + Changed = 1, + Deleted = 2 + } + export type FileWatcherCallback = (fileName: string, eventKind: FileWatcherEventKind) => void; + export type DirectoryWatcherCallback = (fileName: string) => void; + export interface System { + args: string[]; + newLine: string; + useCaseSensitiveFileNames: boolean; + write(s: string): void; + writeOutputIsTTY?(): boolean; + readFile(path: string, encoding?: string): string | undefined; + getFileSize?(path: string): number; + writeFile(path: string, data: string, writeByteOrderMark?: boolean): void; + /** + * @pollingInterval - this parameter is used in polling-based watchers and ignored in watchers that + * use native OS file watching + */ + watchFile?(path: string, callback: FileWatcherCallback, pollingInterval?: number, options?: WatchOptions): FileWatcher; + watchDirectory?(path: string, callback: DirectoryWatcherCallback, recursive?: boolean, options?: WatchOptions): FileWatcher; + resolvePath(path: string): string; + fileExists(path: string): boolean; + directoryExists(path: string): boolean; + createDirectory(path: string): void; + getExecutingFilePath(): string; + getCurrentDirectory(): string; + getDirectories(path: string): string[]; + readDirectory(path: string, extensions?: readonly string[], exclude?: readonly string[], include?: readonly string[], depth?: number): string[]; + getModifiedTime?(path: string): Date | undefined; + setModifiedTime?(path: string, time: Date): void; + deleteFile?(path: string): void; + /** + * A good implementation is node.js' `crypto.createHash`. (https://nodejs.org/api/crypto.html#crypto_crypto_createhash_algorithm) + */ + createHash?(data: string): string; + /** This must be cryptographically secure. Only implement this method using `crypto.createHash("sha256")`. */ + createSHA256Hash?(data: string): string; + getMemoryUsage?(): number; + exit(exitCode?: number): void; + realpath?(path: string): string; + setTimeout?(callback: (...args: any[]) => void, ms: number, ...args: any[]): any; + clearTimeout?(timeoutId: any): void; + clearScreen?(): void; + base64decode?(input: string): string; + base64encode?(input: string): string; + } + export interface FileWatcher { + close(): void; + } + export function getNodeMajorVersion(): number | undefined; + export let sys: System; + export {}; +} +declare namespace ts { + type ErrorCallback = (message: DiagnosticMessage, length: number) => void; + interface Scanner { + getStartPos(): number; + getToken(): SyntaxKind; + getTextPos(): number; + getTokenPos(): number; + getTokenText(): string; + getTokenValue(): string; + hasUnicodeEscape(): boolean; + hasExtendedUnicodeEscape(): boolean; + hasPrecedingLineBreak(): boolean; + isIdentifier(): boolean; + isReservedWord(): boolean; + isUnterminated(): boolean; + reScanGreaterToken(): SyntaxKind; + reScanSlashToken(): SyntaxKind; + reScanAsteriskEqualsToken(): SyntaxKind; + reScanTemplateToken(isTaggedTemplate: boolean): SyntaxKind; + reScanTemplateHeadOrNoSubstitutionTemplate(): SyntaxKind; + scanJsxIdentifier(): SyntaxKind; + scanJsxAttributeValue(): SyntaxKind; + reScanJsxAttributeValue(): SyntaxKind; + reScanJsxToken(): JsxTokenSyntaxKind; + reScanLessThanToken(): SyntaxKind; + reScanQuestionToken(): SyntaxKind; + scanJsxToken(): JsxTokenSyntaxKind; + scanJsDocToken(): JSDocSyntaxKind; + scan(): SyntaxKind; + getText(): string; + setText(text: string | undefined, start?: number, length?: number): void; + setOnError(onError: ErrorCallback | undefined): void; + setScriptTarget(scriptTarget: ScriptTarget): void; + setLanguageVariant(variant: LanguageVariant): void; + setTextPos(textPos: number): void; + lookAhead(callback: () => T): T; + scanRange(start: number, length: number, callback: () => T): T; + tryScan(callback: () => T): T; + } + function tokenToString(t: SyntaxKind): string | undefined; + function getPositionOfLineAndCharacter(sourceFile: SourceFileLike, line: number, character: number): number; + function getLineAndCharacterOfPosition(sourceFile: SourceFileLike, position: number): LineAndCharacter; + function isWhiteSpaceLike(ch: number): boolean; + /** Does not include line breaks. For that, see isWhiteSpaceLike. */ + function isWhiteSpaceSingleLine(ch: number): boolean; + function isLineBreak(ch: number): boolean; + function couldStartTrivia(text: string, pos: number): boolean; + function forEachLeadingCommentRange(text: string, pos: number, cb: (pos: number, end: number, kind: CommentKind, hasTrailingNewLine: boolean) => U): U | undefined; + function forEachLeadingCommentRange(text: string, pos: number, cb: (pos: number, end: number, kind: CommentKind, hasTrailingNewLine: boolean, state: T) => U, state: T): U | undefined; + function forEachTrailingCommentRange(text: string, pos: number, cb: (pos: number, end: number, kind: CommentKind, hasTrailingNewLine: boolean) => U): U | undefined; + function forEachTrailingCommentRange(text: string, pos: number, cb: (pos: number, end: number, kind: CommentKind, hasTrailingNewLine: boolean, state: T) => U, state: T): U | undefined; + function reduceEachLeadingCommentRange(text: string, pos: number, cb: (pos: number, end: number, kind: CommentKind, hasTrailingNewLine: boolean, state: T, memo: U) => U, state: T, initial: U): U | undefined; + function reduceEachTrailingCommentRange(text: string, pos: number, cb: (pos: number, end: number, kind: CommentKind, hasTrailingNewLine: boolean, state: T, memo: U) => U, state: T, initial: U): U | undefined; + function getLeadingCommentRanges(text: string, pos: number): CommentRange[] | undefined; + function getTrailingCommentRanges(text: string, pos: number): CommentRange[] | undefined; + /** Optionally, get the shebang */ + function getShebang(text: string): string | undefined; + function isIdentifierStart(ch: number, languageVersion: ScriptTarget | undefined): boolean; + function isIdentifierPart(ch: number, languageVersion: ScriptTarget | undefined, identifierVariant?: LanguageVariant): boolean; + function createScanner(languageVersion: ScriptTarget, skipTrivia: boolean, languageVariant?: LanguageVariant, textInitial?: string, onError?: ErrorCallback, start?: number, length?: number): Scanner; +} +declare namespace ts { + function isExternalModuleNameRelative(moduleName: string): boolean; + function sortAndDeduplicateDiagnostics(diagnostics: readonly T[]): SortedReadonlyArray; + function getDefaultLibFileName(options: CompilerOptions): string; + function textSpanEnd(span: TextSpan): number; + function textSpanIsEmpty(span: TextSpan): boolean; + function textSpanContainsPosition(span: TextSpan, position: number): boolean; + function textSpanContainsTextSpan(span: TextSpan, other: TextSpan): boolean; + function textSpanOverlapsWith(span: TextSpan, other: TextSpan): boolean; + function textSpanOverlap(span1: TextSpan, span2: TextSpan): TextSpan | undefined; + function textSpanIntersectsWithTextSpan(span: TextSpan, other: TextSpan): boolean; + function textSpanIntersectsWith(span: TextSpan, start: number, length: number): boolean; + function decodedTextSpanIntersectsWith(start1: number, length1: number, start2: number, length2: number): boolean; + function textSpanIntersectsWithPosition(span: TextSpan, position: number): boolean; + function textSpanIntersection(span1: TextSpan, span2: TextSpan): TextSpan | undefined; + function createTextSpan(start: number, length: number): TextSpan; + function createTextSpanFromBounds(start: number, end: number): TextSpan; + function textChangeRangeNewSpan(range: TextChangeRange): TextSpan; + function textChangeRangeIsUnchanged(range: TextChangeRange): boolean; + function createTextChangeRange(span: TextSpan, newLength: number): TextChangeRange; + let unchangedTextChangeRange: TextChangeRange; + /** + * Called to merge all the changes that occurred across several versions of a script snapshot + * into a single change. i.e. if a user keeps making successive edits to a script we will + * have a text change from V1 to V2, V2 to V3, ..., Vn. + * + * This function will then merge those changes into a single change range valid between V1 and + * Vn. + */ + function collapseTextChangeRangesAcrossMultipleVersions(changes: readonly TextChangeRange[]): TextChangeRange; + function getTypeParameterOwner(d: Declaration): Declaration | undefined; + type ParameterPropertyDeclaration = ParameterDeclaration & { + parent: ConstructorDeclaration; + name: Identifier; + }; + function isParameterPropertyDeclaration(node: Node, parent: Node): node is ParameterPropertyDeclaration; + function isEmptyBindingPattern(node: BindingName): node is BindingPattern; + function isEmptyBindingElement(node: BindingElement): boolean; + function walkUpBindingElementsAndPatterns(binding: BindingElement): VariableDeclaration | ParameterDeclaration; + function getCombinedModifierFlags(node: Declaration): ModifierFlags; + function getCombinedNodeFlags(node: Node): NodeFlags; + /** + * Checks to see if the locale is in the appropriate format, + * and if it is, attempts to set the appropriate language. + */ + function validateLocaleAndSetLanguage(locale: string, sys: { + getExecutingFilePath(): string; + resolvePath(path: string): string; + fileExists(fileName: string): boolean; + readFile(fileName: string): string | undefined; + }, errors?: Push): void; + function getOriginalNode(node: Node): Node; + function getOriginalNode(node: Node, nodeTest: (node: Node) => node is T): T; + function getOriginalNode(node: Node | undefined): Node | undefined; + function getOriginalNode(node: Node | undefined, nodeTest: (node: Node | undefined) => node is T): T | undefined; + /** + * Iterates through the parent chain of a node and performs the callback on each parent until the callback + * returns a truthy value, then returns that value. + * If no such value is found, it applies the callback until the parent pointer is undefined or the callback returns "quit" + * At that point findAncestor returns undefined. + */ + function findAncestor(node: Node | undefined, callback: (element: Node) => element is T): T | undefined; + function findAncestor(node: Node | undefined, callback: (element: Node) => boolean | "quit"): Node | undefined; + /** + * Gets a value indicating whether a node originated in the parse tree. + * + * @param node The node to test. + */ + function isParseTreeNode(node: Node): boolean; + /** + * Gets the original parse tree node for a node. + * + * @param node The original node. + * @returns The original parse tree node if found; otherwise, undefined. + */ + function getParseTreeNode(node: Node | undefined): Node | undefined; + /** + * Gets the original parse tree node for a node. + * + * @param node The original node. + * @param nodeTest A callback used to ensure the correct type of parse tree node is returned. + * @returns The original parse tree node if found; otherwise, undefined. + */ + function getParseTreeNode(node: T | undefined, nodeTest?: (node: Node) => node is T): T | undefined; + /** Add an extra underscore to identifiers that start with two underscores to avoid issues with magic names like '__proto__' */ + function escapeLeadingUnderscores(identifier: string): __String; + /** + * Remove extra underscore from escaped identifier text content. + * + * @param identifier The escaped identifier text. + * @returns The unescaped identifier text. + */ + function unescapeLeadingUnderscores(identifier: __String): string; + function idText(identifierOrPrivateName: Identifier | PrivateIdentifier): string; + function symbolName(symbol: Symbol): string; + function getNameOfJSDocTypedef(declaration: JSDocTypedefTag): Identifier | PrivateIdentifier | undefined; + function getNameOfDeclaration(declaration: Declaration | Expression): DeclarationName | undefined; + /** + * Gets the JSDoc parameter tags for the node if present. + * + * @remarks Returns any JSDoc param tag whose name matches the provided + * parameter, whether a param tag on a containing function + * expression, or a param tag on a variable declaration whose + * initializer is the containing function. The tags closest to the + * node are returned first, so in the previous example, the param + * tag on the containing function expression would be first. + * + * For binding patterns, parameter tags are matched by position. + */ + function getJSDocParameterTags(param: ParameterDeclaration): readonly JSDocParameterTag[]; + /** + * Gets the JSDoc type parameter tags for the node if present. + * + * @remarks Returns any JSDoc template tag whose names match the provided + * parameter, whether a template tag on a containing function + * expression, or a template tag on a variable declaration whose + * initializer is the containing function. The tags closest to the + * node are returned first, so in the previous example, the template + * tag on the containing function expression would be first. + */ + function getJSDocTypeParameterTags(param: TypeParameterDeclaration): readonly JSDocTemplateTag[]; + /** + * Return true if the node has JSDoc parameter tags. + * + * @remarks Includes parameter tags that are not directly on the node, + * for example on a variable declaration whose initializer is a function expression. + */ + function hasJSDocParameterTags(node: FunctionLikeDeclaration | SignatureDeclaration): boolean; + /** Gets the JSDoc augments tag for the node if present */ + function getJSDocAugmentsTag(node: Node): JSDocAugmentsTag | undefined; + /** Gets the JSDoc implements tags for the node if present */ + function getJSDocImplementsTags(node: Node): readonly JSDocImplementsTag[]; + /** Gets the JSDoc class tag for the node if present */ + function getJSDocClassTag(node: Node): JSDocClassTag | undefined; + /** Gets the JSDoc public tag for the node if present */ + function getJSDocPublicTag(node: Node): JSDocPublicTag | undefined; + /** Gets the JSDoc private tag for the node if present */ + function getJSDocPrivateTag(node: Node): JSDocPrivateTag | undefined; + /** Gets the JSDoc protected tag for the node if present */ + function getJSDocProtectedTag(node: Node): JSDocProtectedTag | undefined; + /** Gets the JSDoc protected tag for the node if present */ + function getJSDocReadonlyTag(node: Node): JSDocReadonlyTag | undefined; + /** Gets the JSDoc deprecated tag for the node if present */ + function getJSDocDeprecatedTag(node: Node): JSDocDeprecatedTag | undefined; + /** Gets the JSDoc enum tag for the node if present */ + function getJSDocEnumTag(node: Node): JSDocEnumTag | undefined; + /** Gets the JSDoc this tag for the node if present */ + function getJSDocThisTag(node: Node): JSDocThisTag | undefined; + /** Gets the JSDoc return tag for the node if present */ + function getJSDocReturnTag(node: Node): JSDocReturnTag | undefined; + /** Gets the JSDoc template tag for the node if present */ + function getJSDocTemplateTag(node: Node): JSDocTemplateTag | undefined; + /** Gets the JSDoc type tag for the node if present and valid */ + function getJSDocTypeTag(node: Node): JSDocTypeTag | undefined; + /** + * Gets the type node for the node if provided via JSDoc. + * + * @remarks The search includes any JSDoc param tag that relates + * to the provided parameter, for example a type tag on the + * parameter itself, or a param tag on a containing function + * expression, or a param tag on a variable declaration whose + * initializer is the containing function. The tags closest to the + * node are examined first, so in the previous example, the type + * tag directly on the node would be returned. + */ + function getJSDocType(node: Node): TypeNode | undefined; + /** + * Gets the return type node for the node if provided via JSDoc return tag or type tag. + * + * @remarks `getJSDocReturnTag` just gets the whole JSDoc tag. This function + * gets the type from inside the braces, after the fat arrow, etc. + */ + function getJSDocReturnType(node: Node): TypeNode | undefined; + /** Get all JSDoc tags related to a node, including those on parent nodes. */ + function getJSDocTags(node: Node): readonly JSDocTag[]; + /** Gets all JSDoc tags that match a specified predicate */ + function getAllJSDocTags(node: Node, predicate: (tag: JSDocTag) => tag is T): readonly T[]; + /** Gets all JSDoc tags of a specified kind */ + function getAllJSDocTagsOfKind(node: Node, kind: SyntaxKind): readonly JSDocTag[]; + /** + * Gets the effective type parameters. If the node was parsed in a + * JavaScript file, gets the type parameters from the `@template` tag from JSDoc. + */ + function getEffectiveTypeParameterDeclarations(node: DeclarationWithTypeParameters): readonly TypeParameterDeclaration[]; + function getEffectiveConstraintOfTypeParameter(node: TypeParameterDeclaration): TypeNode | undefined; + function isIdentifierOrPrivateIdentifier(node: Node): node is Identifier | PrivateIdentifier; + function isPropertyAccessChain(node: Node): node is PropertyAccessChain; + function isElementAccessChain(node: Node): node is ElementAccessChain; + function isCallChain(node: Node): node is CallChain; + function isOptionalChain(node: Node): node is PropertyAccessChain | ElementAccessChain | CallChain | NonNullChain; + function isNullishCoalesce(node: Node): boolean; + function isConstTypeReference(node: Node): boolean; + function skipPartiallyEmittedExpressions(node: Expression): Expression; + function skipPartiallyEmittedExpressions(node: Node): Node; + function isNonNullChain(node: Node): node is NonNullChain; + function isBreakOrContinueStatement(node: Node): node is BreakOrContinueStatement; + function isNamedExportBindings(node: Node): node is NamedExportBindings; + function isUnparsedTextLike(node: Node): node is UnparsedTextLike; + function isUnparsedNode(node: Node): node is UnparsedNode; + function isJSDocPropertyLikeTag(node: Node): node is JSDocPropertyLikeTag; + /** + * True if node is of some token syntax kind. + * For example, this is true for an IfKeyword but not for an IfStatement. + * Literals are considered tokens, except TemplateLiteral, but does include TemplateHead/Middle/Tail. + */ + function isToken(n: Node): boolean; + function isLiteralExpression(node: Node): node is LiteralExpression; + function isTemplateLiteralToken(node: Node): node is TemplateLiteralToken; + function isTemplateMiddleOrTemplateTail(node: Node): node is TemplateMiddle | TemplateTail; + function isImportOrExportSpecifier(node: Node): node is ImportSpecifier | ExportSpecifier; + function isTypeOnlyImportOrExportDeclaration(node: Node): node is TypeOnlyCompatibleAliasDeclaration; + function isStringTextContainingNode(node: Node): node is StringLiteral | TemplateLiteralToken; + function isModifier(node: Node): node is Modifier; + function isEntityName(node: Node): node is EntityName; + function isPropertyName(node: Node): node is PropertyName; + function isBindingName(node: Node): node is BindingName; + function isFunctionLike(node: Node): node is SignatureDeclaration; + function isClassElement(node: Node): node is ClassElement; + function isClassLike(node: Node): node is ClassLikeDeclaration; + function isAccessor(node: Node): node is AccessorDeclaration; + function isTypeElement(node: Node): node is TypeElement; + function isClassOrTypeElement(node: Node): node is ClassElement | TypeElement; + function isObjectLiteralElementLike(node: Node): node is ObjectLiteralElementLike; + /** + * Node test that determines whether a node is a valid type node. + * This differs from the `isPartOfTypeNode` function which determines whether a node is *part* + * of a TypeNode. + */ + function isTypeNode(node: Node): node is TypeNode; + function isFunctionOrConstructorTypeNode(node: Node): node is FunctionTypeNode | ConstructorTypeNode; + function isPropertyAccessOrQualifiedName(node: Node): node is PropertyAccessExpression | QualifiedName; + function isCallLikeExpression(node: Node): node is CallLikeExpression; + function isCallOrNewExpression(node: Node): node is CallExpression | NewExpression; + function isTemplateLiteral(node: Node): node is TemplateLiteral; + function isAssertionExpression(node: Node): node is AssertionExpression; + function isIterationStatement(node: Node, lookInLabeledStatements: false): node is IterationStatement; + function isIterationStatement(node: Node, lookInLabeledStatements: boolean): node is IterationStatement | LabeledStatement; + function isJsxOpeningLikeElement(node: Node): node is JsxOpeningLikeElement; + function isCaseOrDefaultClause(node: Node): node is CaseOrDefaultClause; + /** True if node is of a kind that may contain comment text. */ + function isJSDocCommentContainingNode(node: Node): boolean; + function isSetAccessor(node: Node): node is SetAccessorDeclaration; + function isGetAccessor(node: Node): node is GetAccessorDeclaration; + /** True if has initializer node attached to it. */ + function hasOnlyExpressionInitializer(node: Node): node is HasExpressionInitializer; + function isObjectLiteralElement(node: Node): node is ObjectLiteralElement; + function isStringLiteralLike(node: Node): node is StringLiteralLike; +} +declare namespace ts { + const factory: NodeFactory; + function createUnparsedSourceFile(text: string): UnparsedSource; + function createUnparsedSourceFile(inputFile: InputFiles, type: "js" | "dts", stripInternal?: boolean): UnparsedSource; + function createUnparsedSourceFile(text: string, mapPath: string | undefined, map: string | undefined): UnparsedSource; + function createInputFiles(javascriptText: string, declarationText: string): InputFiles; + function createInputFiles(readFileText: (path: string) => string | undefined, javascriptPath: string, javascriptMapPath: string | undefined, declarationPath: string, declarationMapPath: string | undefined, buildInfoPath: string | undefined): InputFiles; + function createInputFiles(javascriptText: string, declarationText: string, javascriptMapPath: string | undefined, javascriptMapText: string | undefined, declarationMapPath: string | undefined, declarationMapText: string | undefined): InputFiles; + /** + * Create an external source map source file reference + */ + function createSourceMapSource(fileName: string, text: string, skipTrivia?: (pos: number) => number): SourceMapSource; + function setOriginalNode(node: T, original: Node | undefined): T; +} +declare namespace ts { + /** + * Clears any `EmitNode` entries from parse-tree nodes. + * @param sourceFile A source file. + */ + function disposeEmitNodes(sourceFile: SourceFile | undefined): void; + /** + * Sets flags that control emit behavior of a node. + */ + function setEmitFlags(node: T, emitFlags: EmitFlags): T; + /** + * Gets a custom text range to use when emitting source maps. + */ + function getSourceMapRange(node: Node): SourceMapRange; + /** + * Sets a custom text range to use when emitting source maps. + */ + function setSourceMapRange(node: T, range: SourceMapRange | undefined): T; + /** + * Gets the TextRange to use for source maps for a token of a node. + */ + function getTokenSourceMapRange(node: Node, token: SyntaxKind): SourceMapRange | undefined; + /** + * Sets the TextRange to use for source maps for a token of a node. + */ + function setTokenSourceMapRange(node: T, token: SyntaxKind, range: SourceMapRange | undefined): T; + /** + * Gets a custom text range to use when emitting comments. + */ + function getCommentRange(node: Node): TextRange; + /** + * Sets a custom text range to use when emitting comments. + */ + function setCommentRange(node: T, range: TextRange): T; + function getSyntheticLeadingComments(node: Node): SynthesizedComment[] | undefined; + function setSyntheticLeadingComments(node: T, comments: SynthesizedComment[] | undefined): T; + function addSyntheticLeadingComment(node: T, kind: SyntaxKind.SingleLineCommentTrivia | SyntaxKind.MultiLineCommentTrivia, text: string, hasTrailingNewLine?: boolean): T; + function getSyntheticTrailingComments(node: Node): SynthesizedComment[] | undefined; + function setSyntheticTrailingComments(node: T, comments: SynthesizedComment[] | undefined): T; + function addSyntheticTrailingComment(node: T, kind: SyntaxKind.SingleLineCommentTrivia | SyntaxKind.MultiLineCommentTrivia, text: string, hasTrailingNewLine?: boolean): T; + function moveSyntheticComments(node: T, original: Node): T; + /** + * Gets the constant value to emit for an expression representing an enum. + */ + function getConstantValue(node: AccessExpression): string | number | undefined; + /** + * Sets the constant value to emit for an expression. + */ + function setConstantValue(node: AccessExpression, value: string | number): AccessExpression; + /** + * Adds an EmitHelper to a node. + */ + function addEmitHelper(node: T, helper: EmitHelper): T; + /** + * Add EmitHelpers to a node. + */ + function addEmitHelpers(node: T, helpers: EmitHelper[] | undefined): T; + /** + * Removes an EmitHelper from a node. + */ + function removeEmitHelper(node: Node, helper: EmitHelper): boolean; + /** + * Gets the EmitHelpers of a node. + */ + function getEmitHelpers(node: Node): EmitHelper[] | undefined; + /** + * Moves matching emit helpers from a source node to a target node. + */ + function moveEmitHelpers(source: Node, target: Node, predicate: (helper: EmitHelper) => boolean): void; +} +declare namespace ts { + function isNumericLiteral(node: Node): node is NumericLiteral; + function isBigIntLiteral(node: Node): node is BigIntLiteral; + function isStringLiteral(node: Node): node is StringLiteral; + function isJsxText(node: Node): node is JsxText; + function isRegularExpressionLiteral(node: Node): node is RegularExpressionLiteral; + function isNoSubstitutionTemplateLiteral(node: Node): node is NoSubstitutionTemplateLiteral; + function isTemplateHead(node: Node): node is TemplateHead; + function isTemplateMiddle(node: Node): node is TemplateMiddle; + function isTemplateTail(node: Node): node is TemplateTail; + function isIdentifier(node: Node): node is Identifier; + function isQualifiedName(node: Node): node is QualifiedName; + function isComputedPropertyName(node: Node): node is ComputedPropertyName; + function isPrivateIdentifier(node: Node): node is PrivateIdentifier; + function isTypeParameterDeclaration(node: Node): node is TypeParameterDeclaration; + function isParameter(node: Node): node is ParameterDeclaration; + function isDecorator(node: Node): node is Decorator; + function isPropertySignature(node: Node): node is PropertySignature; + function isPropertyDeclaration(node: Node): node is PropertyDeclaration; + function isMethodSignature(node: Node): node is MethodSignature; + function isMethodDeclaration(node: Node): node is MethodDeclaration; + function isConstructorDeclaration(node: Node): node is ConstructorDeclaration; + function isGetAccessorDeclaration(node: Node): node is GetAccessorDeclaration; + function isSetAccessorDeclaration(node: Node): node is SetAccessorDeclaration; + function isCallSignatureDeclaration(node: Node): node is CallSignatureDeclaration; + function isConstructSignatureDeclaration(node: Node): node is ConstructSignatureDeclaration; + function isIndexSignatureDeclaration(node: Node): node is IndexSignatureDeclaration; + function isTypePredicateNode(node: Node): node is TypePredicateNode; + function isTypeReferenceNode(node: Node): node is TypeReferenceNode; + function isFunctionTypeNode(node: Node): node is FunctionTypeNode; + function isConstructorTypeNode(node: Node): node is ConstructorTypeNode; + function isTypeQueryNode(node: Node): node is TypeQueryNode; + function isTypeLiteralNode(node: Node): node is TypeLiteralNode; + function isArrayTypeNode(node: Node): node is ArrayTypeNode; + function isTupleTypeNode(node: Node): node is TupleTypeNode; + function isNamedTupleMember(node: Node): node is NamedTupleMember; + function isOptionalTypeNode(node: Node): node is OptionalTypeNode; + function isRestTypeNode(node: Node): node is RestTypeNode; + function isUnionTypeNode(node: Node): node is UnionTypeNode; + function isIntersectionTypeNode(node: Node): node is IntersectionTypeNode; + function isConditionalTypeNode(node: Node): node is ConditionalTypeNode; + function isInferTypeNode(node: Node): node is InferTypeNode; + function isParenthesizedTypeNode(node: Node): node is ParenthesizedTypeNode; + function isThisTypeNode(node: Node): node is ThisTypeNode; + function isTypeOperatorNode(node: Node): node is TypeOperatorNode; + function isIndexedAccessTypeNode(node: Node): node is IndexedAccessTypeNode; + function isMappedTypeNode(node: Node): node is MappedTypeNode; + function isLiteralTypeNode(node: Node): node is LiteralTypeNode; + function isImportTypeNode(node: Node): node is ImportTypeNode; + function isTemplateLiteralTypeSpan(node: Node): node is TemplateLiteralTypeSpan; + function isTemplateLiteralTypeNode(node: Node): node is TemplateLiteralTypeNode; + function isObjectBindingPattern(node: Node): node is ObjectBindingPattern; + function isArrayBindingPattern(node: Node): node is ArrayBindingPattern; + function isBindingElement(node: Node): node is BindingElement; + function isArrayLiteralExpression(node: Node): node is ArrayLiteralExpression; + function isObjectLiteralExpression(node: Node): node is ObjectLiteralExpression; + function isPropertyAccessExpression(node: Node): node is PropertyAccessExpression; + function isElementAccessExpression(node: Node): node is ElementAccessExpression; + function isCallExpression(node: Node): node is CallExpression; + function isNewExpression(node: Node): node is NewExpression; + function isTaggedTemplateExpression(node: Node): node is TaggedTemplateExpression; + function isTypeAssertionExpression(node: Node): node is TypeAssertion; + function isParenthesizedExpression(node: Node): node is ParenthesizedExpression; + function isFunctionExpression(node: Node): node is FunctionExpression; + function isArrowFunction(node: Node): node is ArrowFunction; + function isDeleteExpression(node: Node): node is DeleteExpression; + function isTypeOfExpression(node: Node): node is TypeOfExpression; + function isVoidExpression(node: Node): node is VoidExpression; + function isAwaitExpression(node: Node): node is AwaitExpression; + function isPrefixUnaryExpression(node: Node): node is PrefixUnaryExpression; + function isPostfixUnaryExpression(node: Node): node is PostfixUnaryExpression; + function isBinaryExpression(node: Node): node is BinaryExpression; + function isConditionalExpression(node: Node): node is ConditionalExpression; + function isTemplateExpression(node: Node): node is TemplateExpression; + function isYieldExpression(node: Node): node is YieldExpression; + function isSpreadElement(node: Node): node is SpreadElement; + function isClassExpression(node: Node): node is ClassExpression; + function isOmittedExpression(node: Node): node is OmittedExpression; + function isExpressionWithTypeArguments(node: Node): node is ExpressionWithTypeArguments; + function isAsExpression(node: Node): node is AsExpression; + function isNonNullExpression(node: Node): node is NonNullExpression; + function isMetaProperty(node: Node): node is MetaProperty; + function isSyntheticExpression(node: Node): node is SyntheticExpression; + function isPartiallyEmittedExpression(node: Node): node is PartiallyEmittedExpression; + function isCommaListExpression(node: Node): node is CommaListExpression; + function isTemplateSpan(node: Node): node is TemplateSpan; + function isSemicolonClassElement(node: Node): node is SemicolonClassElement; + function isBlock(node: Node): node is Block; + function isVariableStatement(node: Node): node is VariableStatement; + function isEmptyStatement(node: Node): node is EmptyStatement; + function isExpressionStatement(node: Node): node is ExpressionStatement; + function isIfStatement(node: Node): node is IfStatement; + function isDoStatement(node: Node): node is DoStatement; + function isWhileStatement(node: Node): node is WhileStatement; + function isForStatement(node: Node): node is ForStatement; + function isForInStatement(node: Node): node is ForInStatement; + function isForOfStatement(node: Node): node is ForOfStatement; + function isContinueStatement(node: Node): node is ContinueStatement; + function isBreakStatement(node: Node): node is BreakStatement; + function isReturnStatement(node: Node): node is ReturnStatement; + function isWithStatement(node: Node): node is WithStatement; + function isSwitchStatement(node: Node): node is SwitchStatement; + function isLabeledStatement(node: Node): node is LabeledStatement; + function isThrowStatement(node: Node): node is ThrowStatement; + function isTryStatement(node: Node): node is TryStatement; + function isDebuggerStatement(node: Node): node is DebuggerStatement; + function isVariableDeclaration(node: Node): node is VariableDeclaration; + function isVariableDeclarationList(node: Node): node is VariableDeclarationList; + function isFunctionDeclaration(node: Node): node is FunctionDeclaration; + function isClassDeclaration(node: Node): node is ClassDeclaration; + function isInterfaceDeclaration(node: Node): node is InterfaceDeclaration; + function isTypeAliasDeclaration(node: Node): node is TypeAliasDeclaration; + function isEnumDeclaration(node: Node): node is EnumDeclaration; + function isModuleDeclaration(node: Node): node is ModuleDeclaration; + function isModuleBlock(node: Node): node is ModuleBlock; + function isCaseBlock(node: Node): node is CaseBlock; + function isNamespaceExportDeclaration(node: Node): node is NamespaceExportDeclaration; + function isImportEqualsDeclaration(node: Node): node is ImportEqualsDeclaration; + function isImportDeclaration(node: Node): node is ImportDeclaration; + function isImportClause(node: Node): node is ImportClause; + function isNamespaceImport(node: Node): node is NamespaceImport; + function isNamespaceExport(node: Node): node is NamespaceExport; + function isNamedImports(node: Node): node is NamedImports; + function isImportSpecifier(node: Node): node is ImportSpecifier; + function isExportAssignment(node: Node): node is ExportAssignment; + function isExportDeclaration(node: Node): node is ExportDeclaration; + function isNamedExports(node: Node): node is NamedExports; + function isExportSpecifier(node: Node): node is ExportSpecifier; + function isMissingDeclaration(node: Node): node is MissingDeclaration; + function isNotEmittedStatement(node: Node): node is NotEmittedStatement; + function isExternalModuleReference(node: Node): node is ExternalModuleReference; + function isJsxElement(node: Node): node is JsxElement; + function isJsxSelfClosingElement(node: Node): node is JsxSelfClosingElement; + function isJsxOpeningElement(node: Node): node is JsxOpeningElement; + function isJsxClosingElement(node: Node): node is JsxClosingElement; + function isJsxFragment(node: Node): node is JsxFragment; + function isJsxOpeningFragment(node: Node): node is JsxOpeningFragment; + function isJsxClosingFragment(node: Node): node is JsxClosingFragment; + function isJsxAttribute(node: Node): node is JsxAttribute; + function isJsxAttributes(node: Node): node is JsxAttributes; + function isJsxSpreadAttribute(node: Node): node is JsxSpreadAttribute; + function isJsxExpression(node: Node): node is JsxExpression; + function isCaseClause(node: Node): node is CaseClause; + function isDefaultClause(node: Node): node is DefaultClause; + function isHeritageClause(node: Node): node is HeritageClause; + function isCatchClause(node: Node): node is CatchClause; + function isPropertyAssignment(node: Node): node is PropertyAssignment; + function isShorthandPropertyAssignment(node: Node): node is ShorthandPropertyAssignment; + function isSpreadAssignment(node: Node): node is SpreadAssignment; + function isEnumMember(node: Node): node is EnumMember; + function isUnparsedPrepend(node: Node): node is UnparsedPrepend; + function isSourceFile(node: Node): node is SourceFile; + function isBundle(node: Node): node is Bundle; + function isUnparsedSource(node: Node): node is UnparsedSource; + function isJSDocTypeExpression(node: Node): node is JSDocTypeExpression; + function isJSDocNameReference(node: Node): node is JSDocNameReference; + function isJSDocAllType(node: Node): node is JSDocAllType; + function isJSDocUnknownType(node: Node): node is JSDocUnknownType; + function isJSDocNullableType(node: Node): node is JSDocNullableType; + function isJSDocNonNullableType(node: Node): node is JSDocNonNullableType; + function isJSDocOptionalType(node: Node): node is JSDocOptionalType; + function isJSDocFunctionType(node: Node): node is JSDocFunctionType; + function isJSDocVariadicType(node: Node): node is JSDocVariadicType; + function isJSDocNamepathType(node: Node): node is JSDocNamepathType; + function isJSDoc(node: Node): node is JSDoc; + function isJSDocTypeLiteral(node: Node): node is JSDocTypeLiteral; + function isJSDocSignature(node: Node): node is JSDocSignature; + function isJSDocAugmentsTag(node: Node): node is JSDocAugmentsTag; + function isJSDocAuthorTag(node: Node): node is JSDocAuthorTag; + function isJSDocClassTag(node: Node): node is JSDocClassTag; + function isJSDocCallbackTag(node: Node): node is JSDocCallbackTag; + function isJSDocPublicTag(node: Node): node is JSDocPublicTag; + function isJSDocPrivateTag(node: Node): node is JSDocPrivateTag; + function isJSDocProtectedTag(node: Node): node is JSDocProtectedTag; + function isJSDocReadonlyTag(node: Node): node is JSDocReadonlyTag; + function isJSDocDeprecatedTag(node: Node): node is JSDocDeprecatedTag; + function isJSDocEnumTag(node: Node): node is JSDocEnumTag; + function isJSDocParameterTag(node: Node): node is JSDocParameterTag; + function isJSDocReturnTag(node: Node): node is JSDocReturnTag; + function isJSDocThisTag(node: Node): node is JSDocThisTag; + function isJSDocTypeTag(node: Node): node is JSDocTypeTag; + function isJSDocTemplateTag(node: Node): node is JSDocTemplateTag; + function isJSDocTypedefTag(node: Node): node is JSDocTypedefTag; + function isJSDocUnknownTag(node: Node): node is JSDocUnknownTag; + function isJSDocPropertyTag(node: Node): node is JSDocPropertyTag; + function isJSDocImplementsTag(node: Node): node is JSDocImplementsTag; +} +declare namespace ts { + function setTextRange(range: T, location: TextRange | undefined): T; +} +declare namespace ts { + /** + * Invokes a callback for each child of the given node. The 'cbNode' callback is invoked for all child nodes + * stored in properties. If a 'cbNodes' callback is specified, it is invoked for embedded arrays; otherwise, + * embedded arrays are flattened and the 'cbNode' callback is invoked for each element. If a callback returns + * a truthy value, iteration stops and that value is returned. Otherwise, undefined is returned. + * + * @param node a given node to visit its children + * @param cbNode a callback to be invoked for all child nodes + * @param cbNodes a callback to be invoked for embedded array + * + * @remarks `forEachChild` must visit the children of a node in the order + * that they appear in the source code. The language service depends on this property to locate nodes by position. + */ + export function forEachChild(node: Node, cbNode: (node: Node) => T | undefined, cbNodes?: (nodes: NodeArray) => T | undefined): T | undefined; + export function createSourceFile(fileName: string, sourceText: string, languageVersion: ScriptTarget, setParentNodes?: boolean, scriptKind?: ScriptKind): SourceFile; + export function parseIsolatedEntityName(text: string, languageVersion: ScriptTarget): EntityName | undefined; + /** + * Parse json text into SyntaxTree and return node and parse errors if any + * @param fileName + * @param sourceText + */ + export function parseJsonText(fileName: string, sourceText: string): JsonSourceFile; + export function isExternalModule(file: SourceFile): boolean; + export function updateSourceFile(sourceFile: SourceFile, newText: string, textChangeRange: TextChangeRange, aggressiveChecks?: boolean): SourceFile; + export {}; +} +declare namespace ts { + export function parseCommandLine(commandLine: readonly string[], readFile?: (path: string) => string | undefined): ParsedCommandLine; + export type DiagnosticReporter = (diagnostic: Diagnostic) => void; + /** + * Reports config file diagnostics + */ + export interface ConfigFileDiagnosticsReporter { + /** + * Reports unrecoverable error when parsing config file + */ + onUnRecoverableConfigFileDiagnostic: DiagnosticReporter; + } + /** + * Interface extending ParseConfigHost to support ParseConfigFile that reads config file and reports errors + */ + export interface ParseConfigFileHost extends ParseConfigHost, ConfigFileDiagnosticsReporter { + getCurrentDirectory(): string; + } + /** + * Reads the config file, reports errors if any and exits if the config file cannot be found + */ + export function getParsedCommandLineOfConfigFile(configFileName: string, optionsToExtend: CompilerOptions, host: ParseConfigFileHost, extendedConfigCache?: Map, watchOptionsToExtend?: WatchOptions, extraFileExtensions?: readonly FileExtensionInfo[]): ParsedCommandLine | undefined; + /** + * Read tsconfig.json file + * @param fileName The path to the config file + */ + export function readConfigFile(fileName: string, readFile: (path: string) => string | undefined): { + config?: any; + error?: Diagnostic; + }; + /** + * Parse the text of the tsconfig.json file + * @param fileName The path to the config file + * @param jsonText The text of the config file + */ + export function parseConfigFileTextToJson(fileName: string, jsonText: string): { + config?: any; + error?: Diagnostic; + }; + /** + * Read tsconfig.json file + * @param fileName The path to the config file + */ + export function readJsonConfigFile(fileName: string, readFile: (path: string) => string | undefined): TsConfigSourceFile; + /** + * Convert the json syntax tree into the json value + */ + export function convertToObject(sourceFile: JsonSourceFile, errors: Push): any; + /** + * Parse the contents of a config file (tsconfig.json). + * @param json The contents of the config file to parse + * @param host Instance of ParseConfigHost used to enumerate files in folder. + * @param basePath A root directory to resolve relative path entries in the config + * file to. e.g. outDir + */ + export function parseJsonConfigFileContent(json: any, host: ParseConfigHost, basePath: string, existingOptions?: CompilerOptions, configFileName?: string, resolutionStack?: Path[], extraFileExtensions?: readonly FileExtensionInfo[], extendedConfigCache?: Map, existingWatchOptions?: WatchOptions): ParsedCommandLine; + /** + * Parse the contents of a config file (tsconfig.json). + * @param jsonNode The contents of the config file to parse + * @param host Instance of ParseConfigHost used to enumerate files in folder. + * @param basePath A root directory to resolve relative path entries in the config + * file to. e.g. outDir + */ + export function parseJsonSourceFileConfigFileContent(sourceFile: TsConfigSourceFile, host: ParseConfigHost, basePath: string, existingOptions?: CompilerOptions, configFileName?: string, resolutionStack?: Path[], extraFileExtensions?: readonly FileExtensionInfo[], extendedConfigCache?: Map, existingWatchOptions?: WatchOptions): ParsedCommandLine; + export interface ParsedTsconfig { + raw: any; + options?: CompilerOptions; + watchOptions?: WatchOptions; + typeAcquisition?: TypeAcquisition; + /** + * Note that the case of the config path has not yet been normalized, as no files have been imported into the project yet + */ + extendedConfigPath?: string; + } + export interface ExtendedConfigCacheEntry { + extendedResult: TsConfigSourceFile; + extendedConfig: ParsedTsconfig | undefined; + } + export function convertCompilerOptionsFromJson(jsonOptions: any, basePath: string, configFileName?: string): { + options: CompilerOptions; + errors: Diagnostic[]; + }; + export function convertTypeAcquisitionFromJson(jsonOptions: any, basePath: string, configFileName?: string): { + options: TypeAcquisition; + errors: Diagnostic[]; + }; + export {}; +} +declare namespace ts { + function getEffectiveTypeRoots(options: CompilerOptions, host: GetEffectiveTypeRootsHost): string[] | undefined; + /** + * @param {string | undefined} containingFile - file that contains type reference directive, can be undefined if containing file is unknown. + * This is possible in case if resolution is performed for directives specified via 'types' parameter. In this case initial path for secondary lookups + * is assumed to be the same as root directory of the project. + */ + function resolveTypeReferenceDirective(typeReferenceDirectiveName: string, containingFile: string | undefined, options: CompilerOptions, host: ModuleResolutionHost, redirectedReference?: ResolvedProjectReference): ResolvedTypeReferenceDirectiveWithFailedLookupLocations; + /** + * Given a set of options, returns the set of type directive names + * that should be included for this program automatically. + * This list could either come from the config file, + * or from enumerating the types root + initial secondary types lookup location. + * More type directives might appear in the program later as a result of loading actual source files; + * this list is only the set of defaults that are implicitly included. + */ + function getAutomaticTypeDirectiveNames(options: CompilerOptions, host: ModuleResolutionHost): string[]; + /** + * Cached module resolutions per containing directory. + * This assumes that any module id will have the same resolution for sibling files located in the same folder. + */ + interface ModuleResolutionCache extends NonRelativeModuleNameResolutionCache { + getOrCreateCacheForDirectory(directoryName: string, redirectedReference?: ResolvedProjectReference): Map; + } + /** + * Stored map from non-relative module name to a table: directory -> result of module lookup in this directory + * We support only non-relative module names because resolution of relative module names is usually more deterministic and thus less expensive. + */ + interface NonRelativeModuleNameResolutionCache { + getOrCreateCacheForModuleName(nonRelativeModuleName: string, redirectedReference?: ResolvedProjectReference): PerModuleNameCache; + } + interface PerModuleNameCache { + get(directory: string): ResolvedModuleWithFailedLookupLocations | undefined; + set(directory: string, result: ResolvedModuleWithFailedLookupLocations): void; + } + function createModuleResolutionCache(currentDirectory: string, getCanonicalFileName: (s: string) => string, options?: CompilerOptions): ModuleResolutionCache; + function resolveModuleNameFromCache(moduleName: string, containingFile: string, cache: ModuleResolutionCache): ResolvedModuleWithFailedLookupLocations | undefined; + function resolveModuleName(moduleName: string, containingFile: string, compilerOptions: CompilerOptions, host: ModuleResolutionHost, cache?: ModuleResolutionCache, redirectedReference?: ResolvedProjectReference): ResolvedModuleWithFailedLookupLocations; + function nodeModuleNameResolver(moduleName: string, containingFile: string, compilerOptions: CompilerOptions, host: ModuleResolutionHost, cache?: ModuleResolutionCache, redirectedReference?: ResolvedProjectReference): ResolvedModuleWithFailedLookupLocations; + function classicNameResolver(moduleName: string, containingFile: string, compilerOptions: CompilerOptions, host: ModuleResolutionHost, cache?: NonRelativeModuleNameResolutionCache, redirectedReference?: ResolvedProjectReference): ResolvedModuleWithFailedLookupLocations; +} +declare namespace ts { + /** + * Visits a Node using the supplied visitor, possibly returning a new Node in its place. + * + * @param node The Node to visit. + * @param visitor The callback used to visit the Node. + * @param test A callback to execute to verify the Node is valid. + * @param lift An optional callback to execute to lift a NodeArray into a valid Node. + */ + function visitNode(node: T, visitor: Visitor | undefined, test?: (node: Node) => boolean, lift?: (node: NodeArray) => T): T; + /** + * Visits a Node using the supplied visitor, possibly returning a new Node in its place. + * + * @param node The Node to visit. + * @param visitor The callback used to visit the Node. + * @param test A callback to execute to verify the Node is valid. + * @param lift An optional callback to execute to lift a NodeArray into a valid Node. + */ + function visitNode(node: T | undefined, visitor: Visitor | undefined, test?: (node: Node) => boolean, lift?: (node: NodeArray) => T): T | undefined; + /** + * Visits a NodeArray using the supplied visitor, possibly returning a new NodeArray in its place. + * + * @param nodes The NodeArray to visit. + * @param visitor The callback used to visit a Node. + * @param test A node test to execute for each node. + * @param start An optional value indicating the starting offset at which to start visiting. + * @param count An optional value indicating the maximum number of nodes to visit. + */ + function visitNodes(nodes: NodeArray, visitor: Visitor | undefined, test?: (node: Node) => boolean, start?: number, count?: number): NodeArray; + /** + * Visits a NodeArray using the supplied visitor, possibly returning a new NodeArray in its place. + * + * @param nodes The NodeArray to visit. + * @param visitor The callback used to visit a Node. + * @param test A node test to execute for each node. + * @param start An optional value indicating the starting offset at which to start visiting. + * @param count An optional value indicating the maximum number of nodes to visit. + */ + function visitNodes(nodes: NodeArray | undefined, visitor: Visitor | undefined, test?: (node: Node) => boolean, start?: number, count?: number): NodeArray | undefined; + /** + * Starts a new lexical environment and visits a statement list, ending the lexical environment + * and merging hoisted declarations upon completion. + */ + function visitLexicalEnvironment(statements: NodeArray, visitor: Visitor, context: TransformationContext, start?: number, ensureUseStrict?: boolean, nodesVisitor?: NodesVisitor): NodeArray; + /** + * Starts a new lexical environment and visits a parameter list, suspending the lexical + * environment upon completion. + */ + function visitParameterList(nodes: NodeArray, visitor: Visitor, context: TransformationContext, nodesVisitor?: NodesVisitor): NodeArray; + function visitParameterList(nodes: NodeArray | undefined, visitor: Visitor, context: TransformationContext, nodesVisitor?: NodesVisitor): NodeArray | undefined; + /** + * Resumes a suspended lexical environment and visits a function body, ending the lexical + * environment and merging hoisted declarations upon completion. + */ + function visitFunctionBody(node: FunctionBody, visitor: Visitor, context: TransformationContext): FunctionBody; + /** + * Resumes a suspended lexical environment and visits a function body, ending the lexical + * environment and merging hoisted declarations upon completion. + */ + function visitFunctionBody(node: FunctionBody | undefined, visitor: Visitor, context: TransformationContext): FunctionBody | undefined; + /** + * Resumes a suspended lexical environment and visits a concise body, ending the lexical + * environment and merging hoisted declarations upon completion. + */ + function visitFunctionBody(node: ConciseBody, visitor: Visitor, context: TransformationContext): ConciseBody; + /** + * Visits each child of a Node using the supplied visitor, possibly returning a new Node of the same kind in its place. + * + * @param node The Node whose children will be visited. + * @param visitor The callback used to visit each child. + * @param context A lexical environment context for the visitor. + */ + function visitEachChild(node: T, visitor: Visitor, context: TransformationContext): T; + /** + * Visits each child of a Node using the supplied visitor, possibly returning a new Node of the same kind in its place. + * + * @param node The Node whose children will be visited. + * @param visitor The callback used to visit each child. + * @param context A lexical environment context for the visitor. + */ + function visitEachChild(node: T | undefined, visitor: Visitor, context: TransformationContext, nodesVisitor?: typeof visitNodes, tokenVisitor?: Visitor): T | undefined; +} +declare namespace ts { + function getTsBuildInfoEmitOutputFilePath(options: CompilerOptions): string | undefined; + function getOutputFileNames(commandLine: ParsedCommandLine, inputFileName: string, ignoreCase: boolean): readonly string[]; + function createPrinter(printerOptions?: PrinterOptions, handlers?: PrintHandlers): Printer; +} +declare namespace ts { + export function findConfigFile(searchPath: string, fileExists: (fileName: string) => boolean, configName?: string): string | undefined; + export function resolveTripleslashReference(moduleName: string, containingFile: string): string; + export function createCompilerHost(options: CompilerOptions, setParentNodes?: boolean): CompilerHost; + export function getPreEmitDiagnostics(program: Program, sourceFile?: SourceFile, cancellationToken?: CancellationToken): readonly Diagnostic[]; + export interface FormatDiagnosticsHost { + getCurrentDirectory(): string; + getCanonicalFileName(fileName: string): string; + getNewLine(): string; + } + export function formatDiagnostics(diagnostics: readonly Diagnostic[], host: FormatDiagnosticsHost): string; + export function formatDiagnostic(diagnostic: Diagnostic, host: FormatDiagnosticsHost): string; + export function formatDiagnosticsWithColorAndContext(diagnostics: readonly Diagnostic[], host: FormatDiagnosticsHost): string; + export function flattenDiagnosticMessageText(diag: string | DiagnosticMessageChain | undefined, newLine: string, indent?: number): string; + export function getConfigFileParsingDiagnostics(configFileParseResult: ParsedCommandLine): readonly Diagnostic[]; + /** + * Create a new 'Program' instance. A Program is an immutable collection of 'SourceFile's and a 'CompilerOptions' + * that represent a compilation unit. + * + * Creating a program proceeds from a set of root files, expanding the set of inputs by following imports and + * triple-slash-reference-path directives transitively. '@types' and triple-slash-reference-types are also pulled in. + * + * @param createProgramOptions - The options for creating a program. + * @returns A 'Program' object. + */ + export function createProgram(createProgramOptions: CreateProgramOptions): Program; + /** + * Create a new 'Program' instance. A Program is an immutable collection of 'SourceFile's and a 'CompilerOptions' + * that represent a compilation unit. + * + * Creating a program proceeds from a set of root files, expanding the set of inputs by following imports and + * triple-slash-reference-path directives transitively. '@types' and triple-slash-reference-types are also pulled in. + * + * @param rootNames - A set of root files. + * @param options - The compiler options which should be used. + * @param host - The host interacts with the underlying file system. + * @param oldProgram - Reuses an old program structure. + * @param configFileParsingDiagnostics - error during config file parsing + * @returns A 'Program' object. + */ + export function createProgram(rootNames: readonly string[], options: CompilerOptions, host?: CompilerHost, oldProgram?: Program, configFileParsingDiagnostics?: readonly Diagnostic[]): Program; + /** @deprecated */ export interface ResolveProjectReferencePathHost { + fileExists(fileName: string): boolean; + } + /** + * Returns the target config filename of a project reference. + * Note: The file might not exist. + */ + export function resolveProjectReferencePath(ref: ProjectReference): ResolvedConfigFileName; + /** @deprecated */ export function resolveProjectReferencePath(host: ResolveProjectReferencePathHost, ref: ProjectReference): ResolvedConfigFileName; + export {}; +} +declare namespace ts { + interface EmitOutput { + outputFiles: OutputFile[]; + emitSkipped: boolean; + } + interface OutputFile { + name: string; + writeByteOrderMark: boolean; + text: string; + } +} +declare namespace ts { + type AffectedFileResult = { + result: T; + affected: SourceFile | Program; + } | undefined; + interface BuilderProgramHost { + /** + * return true if file names are treated with case sensitivity + */ + useCaseSensitiveFileNames(): boolean; + /** + * If provided this would be used this hash instead of actual file shape text for detecting changes + */ + createHash?: (data: string) => string; + /** + * When emit or emitNextAffectedFile are called without writeFile, + * this callback if present would be used to write files + */ + writeFile?: WriteFileCallback; + } + /** + * Builder to manage the program state changes + */ + interface BuilderProgram { + /** + * Returns current program + */ + getProgram(): Program; + /** + * Get compiler options of the program + */ + getCompilerOptions(): CompilerOptions; + /** + * Get the source file in the program with file name + */ + getSourceFile(fileName: string): SourceFile | undefined; + /** + * Get a list of files in the program + */ + getSourceFiles(): readonly SourceFile[]; + /** + * Get the diagnostics for compiler options + */ + getOptionsDiagnostics(cancellationToken?: CancellationToken): readonly Diagnostic[]; + /** + * Get the diagnostics that dont belong to any file + */ + getGlobalDiagnostics(cancellationToken?: CancellationToken): readonly Diagnostic[]; + /** + * Get the diagnostics from config file parsing + */ + getConfigFileParsingDiagnostics(): readonly Diagnostic[]; + /** + * Get the syntax diagnostics, for all source files if source file is not supplied + */ + getSyntacticDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): readonly Diagnostic[]; + /** + * Get the declaration diagnostics, for all source files if source file is not supplied + */ + getDeclarationDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): readonly DiagnosticWithLocation[]; + /** + * Get all the dependencies of the file + */ + getAllDependencies(sourceFile: SourceFile): readonly string[]; + /** + * Gets the semantic diagnostics from the program corresponding to this state of file (if provided) or whole program + * The semantic diagnostics are cached and managed here + * Note that it is assumed that when asked about semantic diagnostics through this API, + * the file has been taken out of affected files so it is safe to use cache or get from program and cache the diagnostics + * In case of SemanticDiagnosticsBuilderProgram if the source file is not provided, + * it will iterate through all the affected files, to ensure that cache stays valid and yet provide a way to get all semantic diagnostics + */ + getSemanticDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): readonly Diagnostic[]; + /** + * Emits the JavaScript and declaration files. + * When targetSource file is specified, emits the files corresponding to that source file, + * otherwise for the whole program. + * In case of EmitAndSemanticDiagnosticsBuilderProgram, when targetSourceFile is specified, + * it is assumed that that file is handled from affected file list. If targetSourceFile is not specified, + * it will only emit all the affected files instead of whole program + * + * The first of writeFile if provided, writeFile of BuilderProgramHost if provided, writeFile of compiler host + * in that order would be used to write the files + */ + emit(targetSourceFile?: SourceFile, writeFile?: WriteFileCallback, cancellationToken?: CancellationToken, emitOnlyDtsFiles?: boolean, customTransformers?: CustomTransformers): EmitResult; + /** + * Get the current directory of the program + */ + getCurrentDirectory(): string; + } + /** + * The builder that caches the semantic diagnostics for the program and handles the changed files and affected files + */ + interface SemanticDiagnosticsBuilderProgram extends BuilderProgram { + /** + * Gets the semantic diagnostics from the program for the next affected file and caches it + * Returns undefined if the iteration is complete + */ + getSemanticDiagnosticsOfNextAffectedFile(cancellationToken?: CancellationToken, ignoreSourceFile?: (sourceFile: SourceFile) => boolean): AffectedFileResult; + } + /** + * The builder that can handle the changes in program and iterate through changed file to emit the files + * The semantic diagnostics are cached per file and managed by clearing for the changed/affected files + */ + interface EmitAndSemanticDiagnosticsBuilderProgram extends SemanticDiagnosticsBuilderProgram { + /** + * Emits the next affected file's emit result (EmitResult and sourceFiles emitted) or returns undefined if iteration is complete + * The first of writeFile if provided, writeFile of BuilderProgramHost if provided, writeFile of compiler host + * in that order would be used to write the files + */ + emitNextAffectedFile(writeFile?: WriteFileCallback, cancellationToken?: CancellationToken, emitOnlyDtsFiles?: boolean, customTransformers?: CustomTransformers): AffectedFileResult; + } + /** + * Create the builder to manage semantic diagnostics and cache them + */ + function createSemanticDiagnosticsBuilderProgram(newProgram: Program, host: BuilderProgramHost, oldProgram?: SemanticDiagnosticsBuilderProgram, configFileParsingDiagnostics?: readonly Diagnostic[]): SemanticDiagnosticsBuilderProgram; + function createSemanticDiagnosticsBuilderProgram(rootNames: readonly string[] | undefined, options: CompilerOptions | undefined, host?: CompilerHost, oldProgram?: SemanticDiagnosticsBuilderProgram, configFileParsingDiagnostics?: readonly Diagnostic[], projectReferences?: readonly ProjectReference[]): SemanticDiagnosticsBuilderProgram; + /** + * Create the builder that can handle the changes in program and iterate through changed files + * to emit the those files and manage semantic diagnostics cache as well + */ + function createEmitAndSemanticDiagnosticsBuilderProgram(newProgram: Program, host: BuilderProgramHost, oldProgram?: EmitAndSemanticDiagnosticsBuilderProgram, configFileParsingDiagnostics?: readonly Diagnostic[]): EmitAndSemanticDiagnosticsBuilderProgram; + function createEmitAndSemanticDiagnosticsBuilderProgram(rootNames: readonly string[] | undefined, options: CompilerOptions | undefined, host?: CompilerHost, oldProgram?: EmitAndSemanticDiagnosticsBuilderProgram, configFileParsingDiagnostics?: readonly Diagnostic[], projectReferences?: readonly ProjectReference[]): EmitAndSemanticDiagnosticsBuilderProgram; + /** + * Creates a builder thats just abstraction over program and can be used with watch + */ + function createAbstractBuilder(newProgram: Program, host: BuilderProgramHost, oldProgram?: BuilderProgram, configFileParsingDiagnostics?: readonly Diagnostic[]): BuilderProgram; + function createAbstractBuilder(rootNames: readonly string[] | undefined, options: CompilerOptions | undefined, host?: CompilerHost, oldProgram?: BuilderProgram, configFileParsingDiagnostics?: readonly Diagnostic[], projectReferences?: readonly ProjectReference[]): BuilderProgram; +} +declare namespace ts { + interface ReadBuildProgramHost { + useCaseSensitiveFileNames(): boolean; + getCurrentDirectory(): string; + readFile(fileName: string): string | undefined; + } + function readBuilderProgram(compilerOptions: CompilerOptions, host: ReadBuildProgramHost): EmitAndSemanticDiagnosticsBuilderProgram | undefined; + function createIncrementalCompilerHost(options: CompilerOptions, system?: System): CompilerHost; + interface IncrementalProgramOptions { + rootNames: readonly string[]; + options: CompilerOptions; + configFileParsingDiagnostics?: readonly Diagnostic[]; + projectReferences?: readonly ProjectReference[]; + host?: CompilerHost; + createProgram?: CreateProgram; + } + function createIncrementalProgram({ rootNames, options, configFileParsingDiagnostics, projectReferences, host, createProgram }: IncrementalProgramOptions): T; + type WatchStatusReporter = (diagnostic: Diagnostic, newLine: string, options: CompilerOptions, errorCount?: number) => void; + /** Create the program with rootNames and options, if they are undefined, oldProgram and new configFile diagnostics create new program */ + type CreateProgram = (rootNames: readonly string[] | undefined, options: CompilerOptions | undefined, host?: CompilerHost, oldProgram?: T, configFileParsingDiagnostics?: readonly Diagnostic[], projectReferences?: readonly ProjectReference[] | undefined) => T; + /** Host that has watch functionality used in --watch mode */ + interface WatchHost { + /** If provided, called with Diagnostic message that informs about change in watch status */ + onWatchStatusChange?(diagnostic: Diagnostic, newLine: string, options: CompilerOptions, errorCount?: number): void; + /** Used to watch changes in source files, missing files needed to update the program or config file */ + watchFile(path: string, callback: FileWatcherCallback, pollingInterval?: number, options?: CompilerOptions): FileWatcher; + /** Used to watch resolved module's failed lookup locations, config file specs, type roots where auto type reference directives are added */ + watchDirectory(path: string, callback: DirectoryWatcherCallback, recursive?: boolean, options?: CompilerOptions): FileWatcher; + /** If provided, will be used to set delayed compilation, so that multiple changes in short span are compiled together */ + setTimeout?(callback: (...args: any[]) => void, ms: number, ...args: any[]): any; + /** If provided, will be used to reset existing delayed compilation */ + clearTimeout?(timeoutId: any): void; + } + interface ProgramHost { + /** + * Used to create the program when need for program creation or recreation detected + */ + createProgram: CreateProgram; + useCaseSensitiveFileNames(): boolean; + getNewLine(): string; + getCurrentDirectory(): string; + getDefaultLibFileName(options: CompilerOptions): string; + getDefaultLibLocation?(): string; + createHash?(data: string): string; + /** + * Use to check file presence for source files and + * if resolveModuleNames is not provided (complier is in charge of module resolution) then module files as well + */ + fileExists(path: string): boolean; + /** + * Use to read file text for source files and + * if resolveModuleNames is not provided (complier is in charge of module resolution) then module files as well + */ + readFile(path: string, encoding?: string): string | undefined; + /** If provided, used for module resolution as well as to handle directory structure */ + directoryExists?(path: string): boolean; + /** If provided, used in resolutions as well as handling directory structure */ + getDirectories?(path: string): string[]; + /** If provided, used to cache and handle directory structure modifications */ + readDirectory?(path: string, extensions?: readonly string[], exclude?: readonly string[], include?: readonly string[], depth?: number): string[]; + /** Symbol links resolution */ + realpath?(path: string): string; + /** If provided would be used to write log about compilation */ + trace?(s: string): void; + /** If provided is used to get the environment variable */ + getEnvironmentVariable?(name: string): string | undefined; + /** If provided, used to resolve the module names, otherwise typescript's default module resolution */ + resolveModuleNames?(moduleNames: string[], containingFile: string, reusedNames: string[] | undefined, redirectedReference: ResolvedProjectReference | undefined, options: CompilerOptions): (ResolvedModule | undefined)[]; + /** If provided, used to resolve type reference directives, otherwise typescript's default resolution */ + resolveTypeReferenceDirectives?(typeReferenceDirectiveNames: string[], containingFile: string, redirectedReference: ResolvedProjectReference | undefined, options: CompilerOptions): (ResolvedTypeReferenceDirective | undefined)[]; + } + interface WatchCompilerHost extends ProgramHost, WatchHost { + /** Instead of using output d.ts file from project reference, use its source file */ + useSourceOfProjectReferenceRedirect?(): boolean; + /** If provided, callback to invoke after every new program creation */ + afterProgramCreate?(program: T): void; + } + /** + * Host to create watch with root files and options + */ + interface WatchCompilerHostOfFilesAndCompilerOptions extends WatchCompilerHost { + /** root files to use to generate program */ + rootFiles: string[]; + /** Compiler options */ + options: CompilerOptions; + watchOptions?: WatchOptions; + /** Project References */ + projectReferences?: readonly ProjectReference[]; + } + /** + * Host to create watch with config file + */ + interface WatchCompilerHostOfConfigFile extends WatchCompilerHost, ConfigFileDiagnosticsReporter { + /** Name of the config file to compile */ + configFileName: string; + /** Options to extend */ + optionsToExtend?: CompilerOptions; + watchOptionsToExtend?: WatchOptions; + extraFileExtensions?: readonly FileExtensionInfo[]; + /** + * Used to generate source file names from the config file and its include, exclude, files rules + * and also to cache the directory stucture + */ + readDirectory(path: string, extensions?: readonly string[], exclude?: readonly string[], include?: readonly string[], depth?: number): string[]; + } + interface Watch { + /** Synchronize with host and get updated program */ + getProgram(): T; + /** Closes the watch */ + close(): void; + } + /** + * Creates the watch what generates program using the config file + */ + interface WatchOfConfigFile extends Watch { + } + /** + * Creates the watch that generates program using the root files and compiler options + */ + interface WatchOfFilesAndCompilerOptions extends Watch { + /** Updates the root files in the program, only if this is not config file compilation */ + updateRootFileNames(fileNames: string[]): void; + } + /** + * Create the watch compiler host for either configFile or fileNames and its options + */ + function createWatchCompilerHost(configFileName: string, optionsToExtend: CompilerOptions | undefined, system: System, createProgram?: CreateProgram, reportDiagnostic?: DiagnosticReporter, reportWatchStatus?: WatchStatusReporter, watchOptionsToExtend?: WatchOptions, extraFileExtensions?: readonly FileExtensionInfo[]): WatchCompilerHostOfConfigFile; + function createWatchCompilerHost(rootFiles: string[], options: CompilerOptions, system: System, createProgram?: CreateProgram, reportDiagnostic?: DiagnosticReporter, reportWatchStatus?: WatchStatusReporter, projectReferences?: readonly ProjectReference[], watchOptions?: WatchOptions): WatchCompilerHostOfFilesAndCompilerOptions; + /** + * Creates the watch from the host for root files and compiler options + */ + function createWatchProgram(host: WatchCompilerHostOfFilesAndCompilerOptions): WatchOfFilesAndCompilerOptions; + /** + * Creates the watch from the host for config file + */ + function createWatchProgram(host: WatchCompilerHostOfConfigFile): WatchOfConfigFile; +} +declare namespace ts { + interface BuildOptions { + dry?: boolean; + force?: boolean; + verbose?: boolean; + incremental?: boolean; + assumeChangesOnlyAffectDirectDependencies?: boolean; + traceResolution?: boolean; + [option: string]: CompilerOptionsValue | undefined; + } + type ReportEmitErrorSummary = (errorCount: number) => void; + interface SolutionBuilderHostBase extends ProgramHost { + createDirectory?(path: string): void; + /** + * Should provide create directory and writeFile if done of invalidatedProjects is not invoked with + * writeFileCallback + */ + writeFile?(path: string, data: string, writeByteOrderMark?: boolean): void; + getModifiedTime(fileName: string): Date | undefined; + setModifiedTime(fileName: string, date: Date): void; + deleteFile(fileName: string): void; + getParsedCommandLine?(fileName: string): ParsedCommandLine | undefined; + reportDiagnostic: DiagnosticReporter; + reportSolutionBuilderStatus: DiagnosticReporter; + afterProgramEmitAndDiagnostics?(program: T): void; + } + interface SolutionBuilderHost extends SolutionBuilderHostBase { + reportErrorSummary?: ReportEmitErrorSummary; + } + interface SolutionBuilderWithWatchHost extends SolutionBuilderHostBase, WatchHost { + } + interface SolutionBuilder { + build(project?: string, cancellationToken?: CancellationToken): ExitStatus; + clean(project?: string): ExitStatus; + buildReferences(project: string, cancellationToken?: CancellationToken): ExitStatus; + cleanReferences(project?: string): ExitStatus; + getNextInvalidatedProject(cancellationToken?: CancellationToken): InvalidatedProject | undefined; + } + /** + * Create a function that reports watch status by writing to the system and handles the formating of the diagnostic + */ + function createBuilderStatusReporter(system: System, pretty?: boolean): DiagnosticReporter; + function createSolutionBuilderHost(system?: System, createProgram?: CreateProgram, reportDiagnostic?: DiagnosticReporter, reportSolutionBuilderStatus?: DiagnosticReporter, reportErrorSummary?: ReportEmitErrorSummary): SolutionBuilderHost; + function createSolutionBuilderWithWatchHost(system?: System, createProgram?: CreateProgram, reportDiagnostic?: DiagnosticReporter, reportSolutionBuilderStatus?: DiagnosticReporter, reportWatchStatus?: WatchStatusReporter): SolutionBuilderWithWatchHost; + function createSolutionBuilder(host: SolutionBuilderHost, rootNames: readonly string[], defaultOptions: BuildOptions): SolutionBuilder; + function createSolutionBuilderWithWatch(host: SolutionBuilderWithWatchHost, rootNames: readonly string[], defaultOptions: BuildOptions, baseWatchOptions?: WatchOptions): SolutionBuilder; + enum InvalidatedProjectKind { + Build = 0, + UpdateBundle = 1, + UpdateOutputFileStamps = 2 + } + interface InvalidatedProjectBase { + readonly kind: InvalidatedProjectKind; + readonly project: ResolvedConfigFileName; + /** + * To dispose this project and ensure that all the necessary actions are taken and state is updated accordingly + */ + done(cancellationToken?: CancellationToken, writeFile?: WriteFileCallback, customTransformers?: CustomTransformers): ExitStatus; + getCompilerOptions(): CompilerOptions; + getCurrentDirectory(): string; + } + interface UpdateOutputFileStampsProject extends InvalidatedProjectBase { + readonly kind: InvalidatedProjectKind.UpdateOutputFileStamps; + updateOutputFileStatmps(): void; + } + interface BuildInvalidedProject extends InvalidatedProjectBase { + readonly kind: InvalidatedProjectKind.Build; + getBuilderProgram(): T | undefined; + getProgram(): Program | undefined; + getSourceFile(fileName: string): SourceFile | undefined; + getSourceFiles(): readonly SourceFile[]; + getOptionsDiagnostics(cancellationToken?: CancellationToken): readonly Diagnostic[]; + getGlobalDiagnostics(cancellationToken?: CancellationToken): readonly Diagnostic[]; + getConfigFileParsingDiagnostics(): readonly Diagnostic[]; + getSyntacticDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): readonly Diagnostic[]; + getAllDependencies(sourceFile: SourceFile): readonly string[]; + getSemanticDiagnostics(sourceFile?: SourceFile, cancellationToken?: CancellationToken): readonly Diagnostic[]; + getSemanticDiagnosticsOfNextAffectedFile(cancellationToken?: CancellationToken, ignoreSourceFile?: (sourceFile: SourceFile) => boolean): AffectedFileResult; + emit(targetSourceFile?: SourceFile, writeFile?: WriteFileCallback, cancellationToken?: CancellationToken, emitOnlyDtsFiles?: boolean, customTransformers?: CustomTransformers): EmitResult | undefined; + } + interface UpdateBundleProject extends InvalidatedProjectBase { + readonly kind: InvalidatedProjectKind.UpdateBundle; + emit(writeFile?: WriteFileCallback, customTransformers?: CustomTransformers): EmitResult | BuildInvalidedProject | undefined; + } + type InvalidatedProject = UpdateOutputFileStampsProject | BuildInvalidedProject | UpdateBundleProject; +} +declare namespace ts.server { + type ActionSet = "action::set"; + type ActionInvalidate = "action::invalidate"; + type ActionPackageInstalled = "action::packageInstalled"; + type EventTypesRegistry = "event::typesRegistry"; + type EventBeginInstallTypes = "event::beginInstallTypes"; + type EventEndInstallTypes = "event::endInstallTypes"; + type EventInitializationFailed = "event::initializationFailed"; +} +declare namespace ts.server { + interface TypingInstallerResponse { + readonly kind: ActionSet | ActionInvalidate | EventTypesRegistry | ActionPackageInstalled | EventBeginInstallTypes | EventEndInstallTypes | EventInitializationFailed; + } + interface TypingInstallerRequestWithProjectName { + readonly projectName: string; + } + interface DiscoverTypings extends TypingInstallerRequestWithProjectName { + readonly fileNames: string[]; + readonly projectRootPath: Path; + readonly compilerOptions: CompilerOptions; + readonly watchOptions?: WatchOptions; + readonly typeAcquisition: TypeAcquisition; + readonly unresolvedImports: SortedReadonlyArray; + readonly cachePath?: string; + readonly kind: "discover"; + } + interface CloseProject extends TypingInstallerRequestWithProjectName { + readonly kind: "closeProject"; + } + interface TypesRegistryRequest { + readonly kind: "typesRegistry"; + } + interface InstallPackageRequest extends TypingInstallerRequestWithProjectName { + readonly kind: "installPackage"; + readonly fileName: Path; + readonly packageName: string; + readonly projectRootPath: Path; + } + interface PackageInstalledResponse extends ProjectResponse { + readonly kind: ActionPackageInstalled; + readonly success: boolean; + readonly message: string; + } + interface InitializationFailedResponse extends TypingInstallerResponse { + readonly kind: EventInitializationFailed; + readonly message: string; + readonly stack?: string; + } + interface ProjectResponse extends TypingInstallerResponse { + readonly projectName: string; + } + interface InvalidateCachedTypings extends ProjectResponse { + readonly kind: ActionInvalidate; + } + interface InstallTypes extends ProjectResponse { + readonly kind: EventBeginInstallTypes | EventEndInstallTypes; + readonly eventId: number; + readonly typingsInstallerVersion: string; + readonly packagesToInstall: readonly string[]; + } + interface BeginInstallTypes extends InstallTypes { + readonly kind: EventBeginInstallTypes; + } + interface EndInstallTypes extends InstallTypes { + readonly kind: EventEndInstallTypes; + readonly installSuccess: boolean; + } + interface SetTypings extends ProjectResponse { + readonly typeAcquisition: TypeAcquisition; + readonly compilerOptions: CompilerOptions; + readonly typings: string[]; + readonly unresolvedImports: SortedReadonlyArray; + readonly kind: ActionSet; + } +} +declare namespace ts { + interface Node { + getSourceFile(): SourceFile; + getChildCount(sourceFile?: SourceFile): number; + getChildAt(index: number, sourceFile?: SourceFile): Node; + getChildren(sourceFile?: SourceFile): Node[]; + getStart(sourceFile?: SourceFile, includeJsDocComment?: boolean): number; + getFullStart(): number; + getEnd(): number; + getWidth(sourceFile?: SourceFileLike): number; + getFullWidth(): number; + getLeadingTriviaWidth(sourceFile?: SourceFile): number; + getFullText(sourceFile?: SourceFile): string; + getText(sourceFile?: SourceFile): string; + getFirstToken(sourceFile?: SourceFile): Node | undefined; + getLastToken(sourceFile?: SourceFile): Node | undefined; + forEachChild(cbNode: (node: Node) => T | undefined, cbNodeArray?: (nodes: NodeArray) => T | undefined): T | undefined; + } + interface Identifier { + readonly text: string; + } + interface PrivateIdentifier { + readonly text: string; + } + interface Symbol { + readonly name: string; + getFlags(): SymbolFlags; + getEscapedName(): __String; + getName(): string; + getDeclarations(): Declaration[] | undefined; + getDocumentationComment(typeChecker: TypeChecker | undefined): SymbolDisplayPart[]; + getJsDocTags(): JSDocTagInfo[]; + } + interface Type { + getFlags(): TypeFlags; + getSymbol(): Symbol | undefined; + getProperties(): Symbol[]; + getProperty(propertyName: string): Symbol | undefined; + getApparentProperties(): Symbol[]; + getCallSignatures(): readonly Signature[]; + getConstructSignatures(): readonly Signature[]; + getStringIndexType(): Type | undefined; + getNumberIndexType(): Type | undefined; + getBaseTypes(): BaseType[] | undefined; + getNonNullableType(): Type; + getConstraint(): Type | undefined; + getDefault(): Type | undefined; + isUnion(): this is UnionType; + isIntersection(): this is IntersectionType; + isUnionOrIntersection(): this is UnionOrIntersectionType; + isLiteral(): this is LiteralType; + isStringLiteral(): this is StringLiteralType; + isNumberLiteral(): this is NumberLiteralType; + isTypeParameter(): this is TypeParameter; + isClassOrInterface(): this is InterfaceType; + isClass(): this is InterfaceType; + } + interface TypeReference { + typeArguments?: readonly Type[]; + } + interface Signature { + getDeclaration(): SignatureDeclaration; + getTypeParameters(): TypeParameter[] | undefined; + getParameters(): Symbol[]; + getReturnType(): Type; + getDocumentationComment(typeChecker: TypeChecker | undefined): SymbolDisplayPart[]; + getJsDocTags(): JSDocTagInfo[]; + } + interface SourceFile { + getLineAndCharacterOfPosition(pos: number): LineAndCharacter; + getLineEndOfPosition(pos: number): number; + getLineStarts(): readonly number[]; + getPositionOfLineAndCharacter(line: number, character: number): number; + update(newText: string, textChangeRange: TextChangeRange): SourceFile; + } + interface SourceFileLike { + getLineAndCharacterOfPosition(pos: number): LineAndCharacter; + } + interface SourceMapSource { + getLineAndCharacterOfPosition(pos: number): LineAndCharacter; + } + /** + * Represents an immutable snapshot of a script at a specified time.Once acquired, the + * snapshot is observably immutable. i.e. the same calls with the same parameters will return + * the same values. + */ + interface IScriptSnapshot { + /** Gets a portion of the script snapshot specified by [start, end). */ + getText(start: number, end: number): string; + /** Gets the length of this script snapshot. */ + getLength(): number; + /** + * Gets the TextChangeRange that describe how the text changed between this text and + * an older version. This information is used by the incremental parser to determine + * what sections of the script need to be re-parsed. 'undefined' can be returned if the + * change range cannot be determined. However, in that case, incremental parsing will + * not happen and the entire document will be re - parsed. + */ + getChangeRange(oldSnapshot: IScriptSnapshot): TextChangeRange | undefined; + /** Releases all resources held by this script snapshot */ + dispose?(): void; + } + namespace ScriptSnapshot { + function fromString(text: string): IScriptSnapshot; + } + interface PreProcessedFileInfo { + referencedFiles: FileReference[]; + typeReferenceDirectives: FileReference[]; + libReferenceDirectives: FileReference[]; + importedFiles: FileReference[]; + ambientExternalModules?: string[]; + isLibFile: boolean; + } + interface HostCancellationToken { + isCancellationRequested(): boolean; + } + interface InstallPackageOptions { + fileName: Path; + packageName: string; + } + interface PerformanceEvent { + kind: "UpdateGraph" | "CreatePackageJsonAutoImportProvider"; + durationMs: number; + } + enum LanguageServiceMode { + Semantic = 0, + PartialSemantic = 1, + Syntactic = 2 + } + interface LanguageServiceHost extends GetEffectiveTypeRootsHost { + getCompilationSettings(): CompilerOptions; + getNewLine?(): string; + getProjectVersion?(): string; + getScriptFileNames(): string[]; + getScriptKind?(fileName: string): ScriptKind; + getScriptVersion(fileName: string): string; + getScriptSnapshot(fileName: string): IScriptSnapshot | undefined; + getProjectReferences?(): readonly ProjectReference[] | undefined; + getLocalizedDiagnosticMessages?(): any; + getCancellationToken?(): HostCancellationToken; + getCurrentDirectory(): string; + getDefaultLibFileName(options: CompilerOptions): string; + log?(s: string): void; + trace?(s: string): void; + error?(s: string): void; + useCaseSensitiveFileNames?(): boolean; + readDirectory?(path: string, extensions?: readonly string[], exclude?: readonly string[], include?: readonly string[], depth?: number): string[]; + readFile?(path: string, encoding?: string): string | undefined; + realpath?(path: string): string; + fileExists?(path: string): boolean; + getTypeRootsVersion?(): number; + resolveModuleNames?(moduleNames: string[], containingFile: string, reusedNames: string[] | undefined, redirectedReference: ResolvedProjectReference | undefined, options: CompilerOptions): (ResolvedModule | undefined)[]; + getResolvedModuleWithFailedLookupLocationsFromCache?(modulename: string, containingFile: string): ResolvedModuleWithFailedLookupLocations | undefined; + resolveTypeReferenceDirectives?(typeDirectiveNames: string[], containingFile: string, redirectedReference: ResolvedProjectReference | undefined, options: CompilerOptions): (ResolvedTypeReferenceDirective | undefined)[]; + getDirectories?(directoryName: string): string[]; + /** + * Gets a set of custom transformers to use during emit. + */ + getCustomTransformers?(): CustomTransformers | undefined; + isKnownTypesPackageName?(name: string): boolean; + installPackage?(options: InstallPackageOptions): Promise; + writeFile?(fileName: string, content: string): void; + } + type WithMetadata = T & { + metadata?: unknown; + }; + enum SemanticClassificationFormat { + Original = "original", + TwentyTwenty = "2020" + } + interface LanguageService { + /** This is used as a part of restarting the language service. */ + cleanupSemanticCache(): void; + /** + * Gets errors indicating invalid syntax in a file. + * + * In English, "this cdeo have, erorrs" is syntactically invalid because it has typos, + * grammatical errors, and misplaced punctuation. Likewise, examples of syntax + * errors in TypeScript are missing parentheses in an `if` statement, mismatched + * curly braces, and using a reserved keyword as a variable name. + * + * These diagnostics are inexpensive to compute and don't require knowledge of + * other files. Note that a non-empty result increases the likelihood of false positives + * from `getSemanticDiagnostics`. + * + * While these represent the majority of syntax-related diagnostics, there are some + * that require the type system, which will be present in `getSemanticDiagnostics`. + * + * @param fileName A path to the file you want syntactic diagnostics for + */ + getSyntacticDiagnostics(fileName: string): DiagnosticWithLocation[]; + /** + * Gets warnings or errors indicating type system issues in a given file. + * Requesting semantic diagnostics may start up the type system and + * run deferred work, so the first call may take longer than subsequent calls. + * + * Unlike the other get*Diagnostics functions, these diagnostics can potentially not + * include a reference to a source file. Specifically, the first time this is called, + * it will return global diagnostics with no associated location. + * + * To contrast the differences between semantic and syntactic diagnostics, consider the + * sentence: "The sun is green." is syntactically correct; those are real English words with + * correct sentence structure. However, it is semantically invalid, because it is not true. + * + * @param fileName A path to the file you want semantic diagnostics for + */ + getSemanticDiagnostics(fileName: string): Diagnostic[]; + /** + * Gets suggestion diagnostics for a specific file. These diagnostics tend to + * proactively suggest refactors, as opposed to diagnostics that indicate + * potentially incorrect runtime behavior. + * + * @param fileName A path to the file you want semantic diagnostics for + */ + getSuggestionDiagnostics(fileName: string): DiagnosticWithLocation[]; + /** + * Gets global diagnostics related to the program configuration and compiler options. + */ + getCompilerOptionsDiagnostics(): Diagnostic[]; + /** @deprecated Use getEncodedSyntacticClassifications instead. */ + getSyntacticClassifications(fileName: string, span: TextSpan): ClassifiedSpan[]; + getSyntacticClassifications(fileName: string, span: TextSpan, format: SemanticClassificationFormat): ClassifiedSpan[] | ClassifiedSpan2020[]; + /** @deprecated Use getEncodedSemanticClassifications instead. */ + getSemanticClassifications(fileName: string, span: TextSpan): ClassifiedSpan[]; + getSemanticClassifications(fileName: string, span: TextSpan, format: SemanticClassificationFormat): ClassifiedSpan[] | ClassifiedSpan2020[]; + /** Encoded as triples of [start, length, ClassificationType]. */ + getEncodedSyntacticClassifications(fileName: string, span: TextSpan): Classifications; + /** + * Gets semantic highlights information for a particular file. Has two formats, an older + * version used by VS and a format used by VS Code. + * + * @param fileName The path to the file + * @param position A text span to return results within + * @param format Which format to use, defaults to "original" + * @returns a number array encoded as triples of [start, length, ClassificationType, ...]. + */ + getEncodedSemanticClassifications(fileName: string, span: TextSpan, format?: SemanticClassificationFormat): Classifications; + /** + * Gets completion entries at a particular position in a file. + * + * @param fileName The path to the file + * @param position A zero-based index of the character where you want the entries + * @param options An object describing how the request was triggered and what kinds + * of code actions can be returned with the completions. + */ + getCompletionsAtPosition(fileName: string, position: number, options: GetCompletionsAtPositionOptions | undefined): WithMetadata | undefined; + /** + * Gets the extended details for a completion entry retrieved from `getCompletionsAtPosition`. + * + * @param fileName The path to the file + * @param position A zero based index of the character where you want the entries + * @param entryName The name from an existing completion which came from `getCompletionsAtPosition` + * @param formatOptions How should code samples in the completions be formatted, can be undefined for backwards compatibility + * @param source Source code for the current file, can be undefined for backwards compatibility + * @param preferences User settings, can be undefined for backwards compatibility + */ + getCompletionEntryDetails(fileName: string, position: number, entryName: string, formatOptions: FormatCodeOptions | FormatCodeSettings | undefined, source: string | undefined, preferences: UserPreferences | undefined): CompletionEntryDetails | undefined; + getCompletionEntrySymbol(fileName: string, position: number, name: string, source: string | undefined): Symbol | undefined; + /** + * Gets semantic information about the identifier at a particular position in a + * file. Quick info is what you typically see when you hover in an editor. + * + * @param fileName The path to the file + * @param position A zero-based index of the character where you want the quick info + */ + getQuickInfoAtPosition(fileName: string, position: number): QuickInfo | undefined; + getNameOrDottedNameSpan(fileName: string, startPos: number, endPos: number): TextSpan | undefined; + getBreakpointStatementAtPosition(fileName: string, position: number): TextSpan | undefined; + getSignatureHelpItems(fileName: string, position: number, options: SignatureHelpItemsOptions | undefined): SignatureHelpItems | undefined; + getRenameInfo(fileName: string, position: number, options?: RenameInfoOptions): RenameInfo; + findRenameLocations(fileName: string, position: number, findInStrings: boolean, findInComments: boolean, providePrefixAndSuffixTextForRename?: boolean): readonly RenameLocation[] | undefined; + getSmartSelectionRange(fileName: string, position: number): SelectionRange; + getDefinitionAtPosition(fileName: string, position: number): readonly DefinitionInfo[] | undefined; + getDefinitionAndBoundSpan(fileName: string, position: number): DefinitionInfoAndBoundSpan | undefined; + getTypeDefinitionAtPosition(fileName: string, position: number): readonly DefinitionInfo[] | undefined; + getImplementationAtPosition(fileName: string, position: number): readonly ImplementationLocation[] | undefined; + getReferencesAtPosition(fileName: string, position: number): ReferenceEntry[] | undefined; + findReferences(fileName: string, position: number): ReferencedSymbol[] | undefined; + getDocumentHighlights(fileName: string, position: number, filesToSearch: string[]): DocumentHighlights[] | undefined; + /** @deprecated */ + getOccurrencesAtPosition(fileName: string, position: number): readonly ReferenceEntry[] | undefined; + getNavigateToItems(searchValue: string, maxResultCount?: number, fileName?: string, excludeDtsFiles?: boolean): NavigateToItem[]; + getNavigationBarItems(fileName: string): NavigationBarItem[]; + getNavigationTree(fileName: string): NavigationTree; + prepareCallHierarchy(fileName: string, position: number): CallHierarchyItem | CallHierarchyItem[] | undefined; + provideCallHierarchyIncomingCalls(fileName: string, position: number): CallHierarchyIncomingCall[]; + provideCallHierarchyOutgoingCalls(fileName: string, position: number): CallHierarchyOutgoingCall[]; + getOutliningSpans(fileName: string): OutliningSpan[]; + getTodoComments(fileName: string, descriptors: TodoCommentDescriptor[]): TodoComment[]; + getBraceMatchingAtPosition(fileName: string, position: number): TextSpan[]; + getIndentationAtPosition(fileName: string, position: number, options: EditorOptions | EditorSettings): number; + getFormattingEditsForRange(fileName: string, start: number, end: number, options: FormatCodeOptions | FormatCodeSettings): TextChange[]; + getFormattingEditsForDocument(fileName: string, options: FormatCodeOptions | FormatCodeSettings): TextChange[]; + getFormattingEditsAfterKeystroke(fileName: string, position: number, key: string, options: FormatCodeOptions | FormatCodeSettings): TextChange[]; + getDocCommentTemplateAtPosition(fileName: string, position: number): TextInsertion | undefined; + isValidBraceCompletionAtPosition(fileName: string, position: number, openingBrace: number): boolean; + /** + * This will return a defined result if the position is after the `>` of the opening tag, or somewhere in the text, of a JSXElement with no closing tag. + * Editors should call this after `>` is typed. + */ + getJsxClosingTagAtPosition(fileName: string, position: number): JsxClosingTagInfo | undefined; + getSpanOfEnclosingComment(fileName: string, position: number, onlyMultiLine: boolean): TextSpan | undefined; + toLineColumnOffset?(fileName: string, position: number): LineAndCharacter; + getCodeFixesAtPosition(fileName: string, start: number, end: number, errorCodes: readonly number[], formatOptions: FormatCodeSettings, preferences: UserPreferences): readonly CodeFixAction[]; + getCombinedCodeFix(scope: CombinedCodeFixScope, fixId: {}, formatOptions: FormatCodeSettings, preferences: UserPreferences): CombinedCodeActions; + applyCodeActionCommand(action: CodeActionCommand, formatSettings?: FormatCodeSettings): Promise; + applyCodeActionCommand(action: CodeActionCommand[], formatSettings?: FormatCodeSettings): Promise; + applyCodeActionCommand(action: CodeActionCommand | CodeActionCommand[], formatSettings?: FormatCodeSettings): Promise; + /** @deprecated `fileName` will be ignored */ + applyCodeActionCommand(fileName: string, action: CodeActionCommand): Promise; + /** @deprecated `fileName` will be ignored */ + applyCodeActionCommand(fileName: string, action: CodeActionCommand[]): Promise; + /** @deprecated `fileName` will be ignored */ + applyCodeActionCommand(fileName: string, action: CodeActionCommand | CodeActionCommand[]): Promise; + getApplicableRefactors(fileName: string, positionOrRange: number | TextRange, preferences: UserPreferences | undefined, triggerReason?: RefactorTriggerReason): ApplicableRefactorInfo[]; + getEditsForRefactor(fileName: string, formatOptions: FormatCodeSettings, positionOrRange: number | TextRange, refactorName: string, actionName: string, preferences: UserPreferences | undefined): RefactorEditInfo | undefined; + organizeImports(scope: OrganizeImportsScope, formatOptions: FormatCodeSettings, preferences: UserPreferences | undefined): readonly FileTextChanges[]; + getEditsForFileRename(oldFilePath: string, newFilePath: string, formatOptions: FormatCodeSettings, preferences: UserPreferences | undefined): readonly FileTextChanges[]; + getEmitOutput(fileName: string, emitOnlyDtsFiles?: boolean, forceDtsEmit?: boolean): EmitOutput; + getProgram(): Program | undefined; + toggleLineComment(fileName: string, textRange: TextRange): TextChange[]; + toggleMultilineComment(fileName: string, textRange: TextRange): TextChange[]; + commentSelection(fileName: string, textRange: TextRange): TextChange[]; + uncommentSelection(fileName: string, textRange: TextRange): TextChange[]; + dispose(): void; + } + interface JsxClosingTagInfo { + readonly newText: string; + } + interface CombinedCodeFixScope { + type: "file"; + fileName: string; + } + type OrganizeImportsScope = CombinedCodeFixScope; + type CompletionsTriggerCharacter = "." | '"' | "'" | "`" | "/" | "@" | "<" | "#"; + interface GetCompletionsAtPositionOptions extends UserPreferences { + /** + * If the editor is asking for completions because a certain character was typed + * (as opposed to when the user explicitly requested them) this should be set. + */ + triggerCharacter?: CompletionsTriggerCharacter; + /** @deprecated Use includeCompletionsForModuleExports */ + includeExternalModuleExports?: boolean; + /** @deprecated Use includeCompletionsWithInsertText */ + includeInsertTextCompletions?: boolean; + } + type SignatureHelpTriggerCharacter = "," | "(" | "<"; + type SignatureHelpRetriggerCharacter = SignatureHelpTriggerCharacter | ")"; + interface SignatureHelpItemsOptions { + triggerReason?: SignatureHelpTriggerReason; + } + type SignatureHelpTriggerReason = SignatureHelpInvokedReason | SignatureHelpCharacterTypedReason | SignatureHelpRetriggeredReason; + /** + * Signals that the user manually requested signature help. + * The language service will unconditionally attempt to provide a result. + */ + interface SignatureHelpInvokedReason { + kind: "invoked"; + triggerCharacter?: undefined; + } + /** + * Signals that the signature help request came from a user typing a character. + * Depending on the character and the syntactic context, the request may or may not be served a result. + */ + interface SignatureHelpCharacterTypedReason { + kind: "characterTyped"; + /** + * Character that was responsible for triggering signature help. + */ + triggerCharacter: SignatureHelpTriggerCharacter; + } + /** + * Signals that this signature help request came from typing a character or moving the cursor. + * This should only occur if a signature help session was already active and the editor needs to see if it should adjust. + * The language service will unconditionally attempt to provide a result. + * `triggerCharacter` can be `undefined` for a retrigger caused by a cursor move. + */ + interface SignatureHelpRetriggeredReason { + kind: "retrigger"; + /** + * Character that was responsible for triggering signature help. + */ + triggerCharacter?: SignatureHelpRetriggerCharacter; + } + interface ApplyCodeActionCommandResult { + successMessage: string; + } + interface Classifications { + spans: number[]; + endOfLineState: EndOfLineState; + } + interface ClassifiedSpan { + textSpan: TextSpan; + classificationType: ClassificationTypeNames; + } + interface ClassifiedSpan2020 { + textSpan: TextSpan; + classificationType: number; + } + /** + * Navigation bar interface designed for visual studio's dual-column layout. + * This does not form a proper tree. + * The navbar is returned as a list of top-level items, each of which has a list of child items. + * Child items always have an empty array for their `childItems`. + */ + interface NavigationBarItem { + text: string; + kind: ScriptElementKind; + kindModifiers: string; + spans: TextSpan[]; + childItems: NavigationBarItem[]; + indent: number; + bolded: boolean; + grayed: boolean; + } + /** + * Node in a tree of nested declarations in a file. + * The top node is always a script or module node. + */ + interface NavigationTree { + /** Name of the declaration, or a short description, e.g. "". */ + text: string; + kind: ScriptElementKind; + /** ScriptElementKindModifier separated by commas, e.g. "public,abstract" */ + kindModifiers: string; + /** + * Spans of the nodes that generated this declaration. + * There will be more than one if this is the result of merging. + */ + spans: TextSpan[]; + nameSpan: TextSpan | undefined; + /** Present if non-empty */ + childItems?: NavigationTree[]; + } + interface CallHierarchyItem { + name: string; + kind: ScriptElementKind; + kindModifiers?: string; + file: string; + span: TextSpan; + selectionSpan: TextSpan; + containerName?: string; + } + interface CallHierarchyIncomingCall { + from: CallHierarchyItem; + fromSpans: TextSpan[]; + } + interface CallHierarchyOutgoingCall { + to: CallHierarchyItem; + fromSpans: TextSpan[]; + } + interface TodoCommentDescriptor { + text: string; + priority: number; + } + interface TodoComment { + descriptor: TodoCommentDescriptor; + message: string; + position: number; + } + interface TextChange { + span: TextSpan; + newText: string; + } + interface FileTextChanges { + fileName: string; + textChanges: readonly TextChange[]; + isNewFile?: boolean; + } + interface CodeAction { + /** Description of the code action to display in the UI of the editor */ + description: string; + /** Text changes to apply to each file as part of the code action */ + changes: FileTextChanges[]; + /** + * If the user accepts the code fix, the editor should send the action back in a `applyAction` request. + * This allows the language service to have side effects (e.g. installing dependencies) upon a code fix. + */ + commands?: CodeActionCommand[]; + } + interface CodeFixAction extends CodeAction { + /** Short name to identify the fix, for use by telemetry. */ + fixName: string; + /** + * If present, one may call 'getCombinedCodeFix' with this fixId. + * This may be omitted to indicate that the code fix can't be applied in a group. + */ + fixId?: {}; + fixAllDescription?: string; + } + interface CombinedCodeActions { + changes: readonly FileTextChanges[]; + commands?: readonly CodeActionCommand[]; + } + type CodeActionCommand = InstallPackageAction; + interface InstallPackageAction { + } + /** + * A set of one or more available refactoring actions, grouped under a parent refactoring. + */ + interface ApplicableRefactorInfo { + /** + * The programmatic name of the refactoring + */ + name: string; + /** + * A description of this refactoring category to show to the user. + * If the refactoring gets inlined (see below), this text will not be visible. + */ + description: string; + /** + * Inlineable refactorings can have their actions hoisted out to the top level + * of a context menu. Non-inlineanable refactorings should always be shown inside + * their parent grouping. + * + * If not specified, this value is assumed to be 'true' + */ + inlineable?: boolean; + actions: RefactorActionInfo[]; + } + /** + * Represents a single refactoring action - for example, the "Extract Method..." refactor might + * offer several actions, each corresponding to a surround class or closure to extract into. + */ + interface RefactorActionInfo { + /** + * The programmatic name of the refactoring action + */ + name: string; + /** + * A description of this refactoring action to show to the user. + * If the parent refactoring is inlined away, this will be the only text shown, + * so this description should make sense by itself if the parent is inlineable=true + */ + description: string; + /** + * A message to show to the user if the refactoring cannot be applied in + * the current context. + */ + notApplicableReason?: string; + } + /** + * A set of edits to make in response to a refactor action, plus an optional + * location where renaming should be invoked from + */ + interface RefactorEditInfo { + edits: FileTextChanges[]; + renameFilename?: string; + renameLocation?: number; + commands?: CodeActionCommand[]; + } + type RefactorTriggerReason = "implicit" | "invoked"; + interface TextInsertion { + newText: string; + /** The position in newText the caret should point to after the insertion. */ + caretOffset: number; + } + interface DocumentSpan { + textSpan: TextSpan; + fileName: string; + /** + * If the span represents a location that was remapped (e.g. via a .d.ts.map file), + * then the original filename and span will be specified here + */ + originalTextSpan?: TextSpan; + originalFileName?: string; + /** + * If DocumentSpan.textSpan is the span for name of the declaration, + * then this is the span for relevant declaration + */ + contextSpan?: TextSpan; + originalContextSpan?: TextSpan; + } + interface RenameLocation extends DocumentSpan { + readonly prefixText?: string; + readonly suffixText?: string; + } + interface ReferenceEntry extends DocumentSpan { + isWriteAccess: boolean; + isDefinition: boolean; + isInString?: true; + } + interface ImplementationLocation extends DocumentSpan { + kind: ScriptElementKind; + displayParts: SymbolDisplayPart[]; + } + enum HighlightSpanKind { + none = "none", + definition = "definition", + reference = "reference", + writtenReference = "writtenReference" + } + interface HighlightSpan { + fileName?: string; + isInString?: true; + textSpan: TextSpan; + contextSpan?: TextSpan; + kind: HighlightSpanKind; + } + interface NavigateToItem { + name: string; + kind: ScriptElementKind; + kindModifiers: string; + matchKind: "exact" | "prefix" | "substring" | "camelCase"; + isCaseSensitive: boolean; + fileName: string; + textSpan: TextSpan; + containerName: string; + containerKind: ScriptElementKind; + } + enum IndentStyle { + None = 0, + Block = 1, + Smart = 2 + } + enum SemicolonPreference { + Ignore = "ignore", + Insert = "insert", + Remove = "remove" + } + interface EditorOptions { + BaseIndentSize?: number; + IndentSize: number; + TabSize: number; + NewLineCharacter: string; + ConvertTabsToSpaces: boolean; + IndentStyle: IndentStyle; + } + interface EditorSettings { + baseIndentSize?: number; + indentSize?: number; + tabSize?: number; + newLineCharacter?: string; + convertTabsToSpaces?: boolean; + indentStyle?: IndentStyle; + trimTrailingWhitespace?: boolean; + } + interface FormatCodeOptions extends EditorOptions { + InsertSpaceAfterCommaDelimiter: boolean; + InsertSpaceAfterSemicolonInForStatements: boolean; + InsertSpaceBeforeAndAfterBinaryOperators: boolean; + InsertSpaceAfterConstructor?: boolean; + InsertSpaceAfterKeywordsInControlFlowStatements: boolean; + InsertSpaceAfterFunctionKeywordForAnonymousFunctions: boolean; + InsertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis: boolean; + InsertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets: boolean; + InsertSpaceAfterOpeningAndBeforeClosingNonemptyBraces?: boolean; + InsertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces: boolean; + InsertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces?: boolean; + InsertSpaceAfterTypeAssertion?: boolean; + InsertSpaceBeforeFunctionParenthesis?: boolean; + PlaceOpenBraceOnNewLineForFunctions: boolean; + PlaceOpenBraceOnNewLineForControlBlocks: boolean; + insertSpaceBeforeTypeAnnotation?: boolean; + } + interface FormatCodeSettings extends EditorSettings { + readonly insertSpaceAfterCommaDelimiter?: boolean; + readonly insertSpaceAfterSemicolonInForStatements?: boolean; + readonly insertSpaceBeforeAndAfterBinaryOperators?: boolean; + readonly insertSpaceAfterConstructor?: boolean; + readonly insertSpaceAfterKeywordsInControlFlowStatements?: boolean; + readonly insertSpaceAfterFunctionKeywordForAnonymousFunctions?: boolean; + readonly insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis?: boolean; + readonly insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets?: boolean; + readonly insertSpaceAfterOpeningAndBeforeClosingNonemptyBraces?: boolean; + readonly insertSpaceAfterOpeningAndBeforeClosingEmptyBraces?: boolean; + readonly insertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces?: boolean; + readonly insertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces?: boolean; + readonly insertSpaceAfterTypeAssertion?: boolean; + readonly insertSpaceBeforeFunctionParenthesis?: boolean; + readonly placeOpenBraceOnNewLineForFunctions?: boolean; + readonly placeOpenBraceOnNewLineForControlBlocks?: boolean; + readonly insertSpaceBeforeTypeAnnotation?: boolean; + readonly indentMultiLineObjectLiteralBeginningOnBlankLine?: boolean; + readonly semicolons?: SemicolonPreference; + } + function getDefaultFormatCodeSettings(newLineCharacter?: string): FormatCodeSettings; + interface DefinitionInfo extends DocumentSpan { + kind: ScriptElementKind; + name: string; + containerKind: ScriptElementKind; + containerName: string; + } + interface DefinitionInfoAndBoundSpan { + definitions?: readonly DefinitionInfo[]; + textSpan: TextSpan; + } + interface ReferencedSymbolDefinitionInfo extends DefinitionInfo { + displayParts: SymbolDisplayPart[]; + } + interface ReferencedSymbol { + definition: ReferencedSymbolDefinitionInfo; + references: ReferenceEntry[]; + } + enum SymbolDisplayPartKind { + aliasName = 0, + className = 1, + enumName = 2, + fieldName = 3, + interfaceName = 4, + keyword = 5, + lineBreak = 6, + numericLiteral = 7, + stringLiteral = 8, + localName = 9, + methodName = 10, + moduleName = 11, + operator = 12, + parameterName = 13, + propertyName = 14, + punctuation = 15, + space = 16, + text = 17, + typeParameterName = 18, + enumMemberName = 19, + functionName = 20, + regularExpressionLiteral = 21 + } + interface SymbolDisplayPart { + text: string; + kind: string; + } + interface JSDocTagInfo { + name: string; + text?: string; + } + interface QuickInfo { + kind: ScriptElementKind; + kindModifiers: string; + textSpan: TextSpan; + displayParts?: SymbolDisplayPart[]; + documentation?: SymbolDisplayPart[]; + tags?: JSDocTagInfo[]; + } + type RenameInfo = RenameInfoSuccess | RenameInfoFailure; + interface RenameInfoSuccess { + canRename: true; + /** + * File or directory to rename. + * If set, `getEditsForFileRename` should be called instead of `findRenameLocations`. + */ + fileToRename?: string; + displayName: string; + fullDisplayName: string; + kind: ScriptElementKind; + kindModifiers: string; + triggerSpan: TextSpan; + } + interface RenameInfoFailure { + canRename: false; + localizedErrorMessage: string; + } + interface RenameInfoOptions { + readonly allowRenameOfImportPath?: boolean; + } + interface SignatureHelpParameter { + name: string; + documentation: SymbolDisplayPart[]; + displayParts: SymbolDisplayPart[]; + isOptional: boolean; + } + interface SelectionRange { + textSpan: TextSpan; + parent?: SelectionRange; + } + /** + * Represents a single signature to show in signature help. + * The id is used for subsequent calls into the language service to ask questions about the + * signature help item in the context of any documents that have been updated. i.e. after + * an edit has happened, while signature help is still active, the host can ask important + * questions like 'what parameter is the user currently contained within?'. + */ + interface SignatureHelpItem { + isVariadic: boolean; + prefixDisplayParts: SymbolDisplayPart[]; + suffixDisplayParts: SymbolDisplayPart[]; + separatorDisplayParts: SymbolDisplayPart[]; + parameters: SignatureHelpParameter[]; + documentation: SymbolDisplayPart[]; + tags: JSDocTagInfo[]; + } + /** + * Represents a set of signature help items, and the preferred item that should be selected. + */ + interface SignatureHelpItems { + items: SignatureHelpItem[]; + applicableSpan: TextSpan; + selectedItemIndex: number; + argumentIndex: number; + argumentCount: number; + } + interface CompletionInfo { + /** Not true for all global completions. This will be true if the enclosing scope matches a few syntax kinds. See `isSnippetScope`. */ + isGlobalCompletion: boolean; + isMemberCompletion: boolean; + /** + * In the absence of `CompletionEntry["replacementSpan"], the editor may choose whether to use + * this span or its default one. If `CompletionEntry["replacementSpan"]` is defined, that span + * must be used to commit that completion entry. + */ + optionalReplacementSpan?: TextSpan; + /** + * true when the current location also allows for a new identifier + */ + isNewIdentifierLocation: boolean; + entries: CompletionEntry[]; + } + interface CompletionEntry { + name: string; + kind: ScriptElementKind; + kindModifiers?: string; + sortText: string; + insertText?: string; + /** + * An optional span that indicates the text to be replaced by this completion item. + * If present, this span should be used instead of the default one. + * It will be set if the required span differs from the one generated by the default replacement behavior. + */ + replacementSpan?: TextSpan; + hasAction?: true; + source?: string; + isRecommended?: true; + isFromUncheckedFile?: true; + isPackageJsonImport?: true; + } + interface CompletionEntryDetails { + name: string; + kind: ScriptElementKind; + kindModifiers: string; + displayParts: SymbolDisplayPart[]; + documentation?: SymbolDisplayPart[]; + tags?: JSDocTagInfo[]; + codeActions?: CodeAction[]; + source?: SymbolDisplayPart[]; + } + interface OutliningSpan { + /** The span of the document to actually collapse. */ + textSpan: TextSpan; + /** The span of the document to display when the user hovers over the collapsed span. */ + hintSpan: TextSpan; + /** The text to display in the editor for the collapsed region. */ + bannerText: string; + /** + * Whether or not this region should be automatically collapsed when + * the 'Collapse to Definitions' command is invoked. + */ + autoCollapse: boolean; + /** + * Classification of the contents of the span + */ + kind: OutliningSpanKind; + } + enum OutliningSpanKind { + /** Single or multi-line comments */ + Comment = "comment", + /** Sections marked by '// #region' and '// #endregion' comments */ + Region = "region", + /** Declarations and expressions */ + Code = "code", + /** Contiguous blocks of import declarations */ + Imports = "imports" + } + enum OutputFileType { + JavaScript = 0, + SourceMap = 1, + Declaration = 2 + } + enum EndOfLineState { + None = 0, + InMultiLineCommentTrivia = 1, + InSingleQuoteStringLiteral = 2, + InDoubleQuoteStringLiteral = 3, + InTemplateHeadOrNoSubstitutionTemplate = 4, + InTemplateMiddleOrTail = 5, + InTemplateSubstitutionPosition = 6 + } + enum TokenClass { + Punctuation = 0, + Keyword = 1, + Operator = 2, + Comment = 3, + Whitespace = 4, + Identifier = 5, + NumberLiteral = 6, + BigIntLiteral = 7, + StringLiteral = 8, + RegExpLiteral = 9 + } + interface ClassificationResult { + finalLexState: EndOfLineState; + entries: ClassificationInfo[]; + } + interface ClassificationInfo { + length: number; + classification: TokenClass; + } + interface Classifier { + /** + * Gives lexical classifications of tokens on a line without any syntactic context. + * For instance, a token consisting of the text 'string' can be either an identifier + * named 'string' or the keyword 'string', however, because this classifier is not aware, + * it relies on certain heuristics to give acceptable results. For classifications where + * speed trumps accuracy, this function is preferable; however, for true accuracy, the + * syntactic classifier is ideal. In fact, in certain editing scenarios, combining the + * lexical, syntactic, and semantic classifiers may issue the best user experience. + * + * @param text The text of a line to classify. + * @param lexState The state of the lexical classifier at the end of the previous line. + * @param syntacticClassifierAbsent Whether the client is *not* using a syntactic classifier. + * If there is no syntactic classifier (syntacticClassifierAbsent=true), + * certain heuristics may be used in its place; however, if there is a + * syntactic classifier (syntacticClassifierAbsent=false), certain + * classifications which may be incorrectly categorized will be given + * back as Identifiers in order to allow the syntactic classifier to + * subsume the classification. + * @deprecated Use getLexicalClassifications instead. + */ + getClassificationsForLine(text: string, lexState: EndOfLineState, syntacticClassifierAbsent: boolean): ClassificationResult; + getEncodedLexicalClassifications(text: string, endOfLineState: EndOfLineState, syntacticClassifierAbsent: boolean): Classifications; + } + enum ScriptElementKind { + unknown = "", + warning = "warning", + /** predefined type (void) or keyword (class) */ + keyword = "keyword", + /** top level script node */ + scriptElement = "script", + /** module foo {} */ + moduleElement = "module", + /** class X {} */ + classElement = "class", + /** var x = class X {} */ + localClassElement = "local class", + /** interface Y {} */ + interfaceElement = "interface", + /** type T = ... */ + typeElement = "type", + /** enum E */ + enumElement = "enum", + enumMemberElement = "enum member", + /** + * Inside module and script only + * const v = .. + */ + variableElement = "var", + /** Inside function */ + localVariableElement = "local var", + /** + * Inside module and script only + * function f() { } + */ + functionElement = "function", + /** Inside function */ + localFunctionElement = "local function", + /** class X { [public|private]* foo() {} } */ + memberFunctionElement = "method", + /** class X { [public|private]* [get|set] foo:number; } */ + memberGetAccessorElement = "getter", + memberSetAccessorElement = "setter", + /** + * class X { [public|private]* foo:number; } + * interface Y { foo:number; } + */ + memberVariableElement = "property", + /** class X { constructor() { } } */ + constructorImplementationElement = "constructor", + /** interface Y { ():number; } */ + callSignatureElement = "call", + /** interface Y { []:number; } */ + indexSignatureElement = "index", + /** interface Y { new():Y; } */ + constructSignatureElement = "construct", + /** function foo(*Y*: string) */ + parameterElement = "parameter", + typeParameterElement = "type parameter", + primitiveType = "primitive type", + label = "label", + alias = "alias", + constElement = "const", + letElement = "let", + directory = "directory", + externalModuleName = "external module name", + /** + * + */ + jsxAttribute = "JSX attribute", + /** String literal */ + string = "string" + } + enum ScriptElementKindModifier { + none = "", + publicMemberModifier = "public", + privateMemberModifier = "private", + protectedMemberModifier = "protected", + exportedModifier = "export", + ambientModifier = "declare", + staticModifier = "static", + abstractModifier = "abstract", + optionalModifier = "optional", + deprecatedModifier = "deprecated", + dtsModifier = ".d.ts", + tsModifier = ".ts", + tsxModifier = ".tsx", + jsModifier = ".js", + jsxModifier = ".jsx", + jsonModifier = ".json" + } + enum ClassificationTypeNames { + comment = "comment", + identifier = "identifier", + keyword = "keyword", + numericLiteral = "number", + bigintLiteral = "bigint", + operator = "operator", + stringLiteral = "string", + whiteSpace = "whitespace", + text = "text", + punctuation = "punctuation", + className = "class name", + enumName = "enum name", + interfaceName = "interface name", + moduleName = "module name", + typeParameterName = "type parameter name", + typeAliasName = "type alias name", + parameterName = "parameter name", + docCommentTagName = "doc comment tag name", + jsxOpenTagName = "jsx open tag name", + jsxCloseTagName = "jsx close tag name", + jsxSelfClosingTagName = "jsx self closing tag name", + jsxAttribute = "jsx attribute", + jsxText = "jsx text", + jsxAttributeStringLiteralValue = "jsx attribute string literal value" + } + enum ClassificationType { + comment = 1, + identifier = 2, + keyword = 3, + numericLiteral = 4, + operator = 5, + stringLiteral = 6, + regularExpressionLiteral = 7, + whiteSpace = 8, + text = 9, + punctuation = 10, + className = 11, + enumName = 12, + interfaceName = 13, + moduleName = 14, + typeParameterName = 15, + typeAliasName = 16, + parameterName = 17, + docCommentTagName = 18, + jsxOpenTagName = 19, + jsxCloseTagName = 20, + jsxSelfClosingTagName = 21, + jsxAttribute = 22, + jsxText = 23, + jsxAttributeStringLiteralValue = 24, + bigintLiteral = 25 + } +} +declare namespace ts { + /** The classifier is used for syntactic highlighting in editors via the TSServer */ + function createClassifier(): Classifier; +} +declare namespace ts { + interface DocumentHighlights { + fileName: string; + highlightSpans: HighlightSpan[]; + } +} +declare namespace ts { + /** + * The document registry represents a store of SourceFile objects that can be shared between + * multiple LanguageService instances. A LanguageService instance holds on the SourceFile (AST) + * of files in the context. + * SourceFile objects account for most of the memory usage by the language service. Sharing + * the same DocumentRegistry instance between different instances of LanguageService allow + * for more efficient memory utilization since all projects will share at least the library + * file (lib.d.ts). + * + * A more advanced use of the document registry is to serialize sourceFile objects to disk + * and re-hydrate them when needed. + * + * To create a default DocumentRegistry, use createDocumentRegistry to create one, and pass it + * to all subsequent createLanguageService calls. + */ + interface DocumentRegistry { + /** + * Request a stored SourceFile with a given fileName and compilationSettings. + * The first call to acquire will call createLanguageServiceSourceFile to generate + * the SourceFile if was not found in the registry. + * + * @param fileName The name of the file requested + * @param compilationSettings Some compilation settings like target affects the + * shape of a the resulting SourceFile. This allows the DocumentRegistry to store + * multiple copies of the same file for different compilation settings. + * @param scriptSnapshot Text of the file. Only used if the file was not found + * in the registry and a new one was created. + * @param version Current version of the file. Only used if the file was not found + * in the registry and a new one was created. + */ + acquireDocument(fileName: string, compilationSettings: CompilerOptions, scriptSnapshot: IScriptSnapshot, version: string, scriptKind?: ScriptKind): SourceFile; + acquireDocumentWithKey(fileName: string, path: Path, compilationSettings: CompilerOptions, key: DocumentRegistryBucketKey, scriptSnapshot: IScriptSnapshot, version: string, scriptKind?: ScriptKind): SourceFile; + /** + * Request an updated version of an already existing SourceFile with a given fileName + * and compilationSettings. The update will in-turn call updateLanguageServiceSourceFile + * to get an updated SourceFile. + * + * @param fileName The name of the file requested + * @param compilationSettings Some compilation settings like target affects the + * shape of a the resulting SourceFile. This allows the DocumentRegistry to store + * multiple copies of the same file for different compilation settings. + * @param scriptSnapshot Text of the file. + * @param version Current version of the file. + */ + updateDocument(fileName: string, compilationSettings: CompilerOptions, scriptSnapshot: IScriptSnapshot, version: string, scriptKind?: ScriptKind): SourceFile; + updateDocumentWithKey(fileName: string, path: Path, compilationSettings: CompilerOptions, key: DocumentRegistryBucketKey, scriptSnapshot: IScriptSnapshot, version: string, scriptKind?: ScriptKind): SourceFile; + getKeyForCompilationSettings(settings: CompilerOptions): DocumentRegistryBucketKey; + /** + * Informs the DocumentRegistry that a file is not needed any longer. + * + * Note: It is not allowed to call release on a SourceFile that was not acquired from + * this registry originally. + * + * @param fileName The name of the file to be released + * @param compilationSettings The compilation settings used to acquire the file + */ + releaseDocument(fileName: string, compilationSettings: CompilerOptions): void; + releaseDocumentWithKey(path: Path, key: DocumentRegistryBucketKey): void; + reportStats(): string; + } + type DocumentRegistryBucketKey = string & { + __bucketKey: any; + }; + function createDocumentRegistry(useCaseSensitiveFileNames?: boolean, currentDirectory?: string): DocumentRegistry; +} +declare namespace ts { + function preProcessFile(sourceText: string, readImportFiles?: boolean, detectJavaScriptImports?: boolean): PreProcessedFileInfo; +} +declare namespace ts { + interface TranspileOptions { + compilerOptions?: CompilerOptions; + fileName?: string; + reportDiagnostics?: boolean; + moduleName?: string; + renamedDependencies?: MapLike; + transformers?: CustomTransformers; + } + interface TranspileOutput { + outputText: string; + diagnostics?: Diagnostic[]; + sourceMapText?: string; + } + function transpileModule(input: string, transpileOptions: TranspileOptions): TranspileOutput; + function transpile(input: string, compilerOptions?: CompilerOptions, fileName?: string, diagnostics?: Diagnostic[], moduleName?: string): string; +} +declare namespace ts { + /** The version of the language service API */ + const servicesVersion = "0.8"; + function toEditorSettings(options: EditorOptions | EditorSettings): EditorSettings; + function displayPartsToString(displayParts: SymbolDisplayPart[] | undefined): string; + function getDefaultCompilerOptions(): CompilerOptions; + function getSupportedCodeFixes(): string[]; + function createLanguageServiceSourceFile(fileName: string, scriptSnapshot: IScriptSnapshot, scriptTarget: ScriptTarget, version: string, setNodeParents: boolean, scriptKind?: ScriptKind): SourceFile; + function updateLanguageServiceSourceFile(sourceFile: SourceFile, scriptSnapshot: IScriptSnapshot, version: string, textChangeRange: TextChangeRange | undefined, aggressiveChecks?: boolean): SourceFile; + function createLanguageService(host: LanguageServiceHost, documentRegistry?: DocumentRegistry, syntaxOnlyOrLanguageServiceMode?: boolean | LanguageServiceMode): LanguageService; + /** + * Get the path of the default library files (lib.d.ts) as distributed with the typescript + * node package. + * The functionality is not supported if the ts module is consumed outside of a node module. + */ + function getDefaultLibFilePath(options: CompilerOptions): string; +} +declare namespace ts { + /** + * Transform one or more nodes using the supplied transformers. + * @param source A single `Node` or an array of `Node` objects. + * @param transformers An array of `TransformerFactory` callbacks used to process the transformation. + * @param compilerOptions Optional compiler options. + */ + function transform(source: T | T[], transformers: TransformerFactory[], compilerOptions?: CompilerOptions): TransformationResult; +} +declare namespace ts { + /** @deprecated Use `factory.createNodeArray` or the factory supplied by your transformation context instead. */ + const createNodeArray: (elements?: readonly T[] | undefined, hasTrailingComma?: boolean | undefined) => NodeArray; + /** @deprecated Use `factory.createNumericLiteral` or the factory supplied by your transformation context instead. */ + const createNumericLiteral: (value: string | number, numericLiteralFlags?: TokenFlags | undefined) => NumericLiteral; + /** @deprecated Use `factory.createBigIntLiteral` or the factory supplied by your transformation context instead. */ + const createBigIntLiteral: (value: string | PseudoBigInt) => BigIntLiteral; + /** @deprecated Use `factory.createStringLiteral` or the factory supplied by your transformation context instead. */ + const createStringLiteral: { + (text: string, isSingleQuote?: boolean | undefined): StringLiteral; + (text: string, isSingleQuote?: boolean | undefined, hasExtendedUnicodeEscape?: boolean | undefined): StringLiteral; + }; + /** @deprecated Use `factory.createStringLiteralFromNode` or the factory supplied by your transformation context instead. */ + const createStringLiteralFromNode: (sourceNode: Identifier | StringLiteral | NoSubstitutionTemplateLiteral | NumericLiteral, isSingleQuote?: boolean | undefined) => StringLiteral; + /** @deprecated Use `factory.createRegularExpressionLiteral` or the factory supplied by your transformation context instead. */ + const createRegularExpressionLiteral: (text: string) => RegularExpressionLiteral; + /** @deprecated Use `factory.createLoopVariable` or the factory supplied by your transformation context instead. */ + const createLoopVariable: () => Identifier; + /** @deprecated Use `factory.createUniqueName` or the factory supplied by your transformation context instead. */ + const createUniqueName: (text: string, flags?: GeneratedIdentifierFlags | undefined) => Identifier; + /** @deprecated Use `factory.createPrivateIdentifier` or the factory supplied by your transformation context instead. */ + const createPrivateIdentifier: (text: string) => PrivateIdentifier; + /** @deprecated Use `factory.createSuper` or the factory supplied by your transformation context instead. */ + const createSuper: () => SuperExpression; + /** @deprecated Use `factory.createThis` or the factory supplied by your transformation context instead. */ + const createThis: () => ThisExpression; + /** @deprecated Use `factory.createNull` or the factory supplied by your transformation context instead. */ + const createNull: () => NullLiteral; + /** @deprecated Use `factory.createTrue` or the factory supplied by your transformation context instead. */ + const createTrue: () => TrueLiteral; + /** @deprecated Use `factory.createFalse` or the factory supplied by your transformation context instead. */ + const createFalse: () => FalseLiteral; + /** @deprecated Use `factory.createModifier` or the factory supplied by your transformation context instead. */ + const createModifier: (kind: T) => ModifierToken; + /** @deprecated Use `factory.createModifiersFromModifierFlags` or the factory supplied by your transformation context instead. */ + const createModifiersFromModifierFlags: (flags: ModifierFlags) => Modifier[]; + /** @deprecated Use `factory.createQualifiedName` or the factory supplied by your transformation context instead. */ + const createQualifiedName: (left: EntityName, right: string | Identifier) => QualifiedName; + /** @deprecated Use `factory.updateQualifiedName` or the factory supplied by your transformation context instead. */ + const updateQualifiedName: (node: QualifiedName, left: EntityName, right: Identifier) => QualifiedName; + /** @deprecated Use `factory.createComputedPropertyName` or the factory supplied by your transformation context instead. */ + const createComputedPropertyName: (expression: Expression) => ComputedPropertyName; + /** @deprecated Use `factory.updateComputedPropertyName` or the factory supplied by your transformation context instead. */ + const updateComputedPropertyName: (node: ComputedPropertyName, expression: Expression) => ComputedPropertyName; + /** @deprecated Use `factory.createTypeParameterDeclaration` or the factory supplied by your transformation context instead. */ + const createTypeParameterDeclaration: (name: string | Identifier, constraint?: TypeNode | undefined, defaultType?: TypeNode | undefined) => TypeParameterDeclaration; + /** @deprecated Use `factory.updateTypeParameterDeclaration` or the factory supplied by your transformation context instead. */ + const updateTypeParameterDeclaration: (node: TypeParameterDeclaration, name: Identifier, constraint: TypeNode | undefined, defaultType: TypeNode | undefined) => TypeParameterDeclaration; + /** @deprecated Use `factory.createParameterDeclaration` or the factory supplied by your transformation context instead. */ + const createParameter: (decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, dotDotDotToken: DotDotDotToken | undefined, name: string | Identifier | ObjectBindingPattern | ArrayBindingPattern, questionToken?: QuestionToken | undefined, type?: TypeNode | undefined, initializer?: Expression | undefined) => ParameterDeclaration; + /** @deprecated Use `factory.updateParameterDeclaration` or the factory supplied by your transformation context instead. */ + const updateParameter: (node: ParameterDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, dotDotDotToken: DotDotDotToken | undefined, name: string | Identifier | ObjectBindingPattern | ArrayBindingPattern, questionToken: QuestionToken | undefined, type: TypeNode | undefined, initializer: Expression | undefined) => ParameterDeclaration; + /** @deprecated Use `factory.createDecorator` or the factory supplied by your transformation context instead. */ + const createDecorator: (expression: Expression) => Decorator; + /** @deprecated Use `factory.updateDecorator` or the factory supplied by your transformation context instead. */ + const updateDecorator: (node: Decorator, expression: Expression) => Decorator; + /** @deprecated Use `factory.createPropertyDeclaration` or the factory supplied by your transformation context instead. */ + const createProperty: (decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier | StringLiteral | NumericLiteral | ComputedPropertyName | PrivateIdentifier, questionOrExclamationToken: QuestionToken | ExclamationToken | undefined, type: TypeNode | undefined, initializer: Expression | undefined) => PropertyDeclaration; + /** @deprecated Use `factory.updatePropertyDeclaration` or the factory supplied by your transformation context instead. */ + const updateProperty: (node: PropertyDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier | StringLiteral | NumericLiteral | ComputedPropertyName | PrivateIdentifier, questionOrExclamationToken: QuestionToken | ExclamationToken | undefined, type: TypeNode | undefined, initializer: Expression | undefined) => PropertyDeclaration; + /** @deprecated Use `factory.createMethodDeclaration` or the factory supplied by your transformation context instead. */ + const createMethod: (decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, asteriskToken: AsteriskToken | undefined, name: string | Identifier | StringLiteral | NumericLiteral | ComputedPropertyName | PrivateIdentifier, questionToken: QuestionToken | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, body: Block | undefined) => MethodDeclaration; + /** @deprecated Use `factory.updateMethodDeclaration` or the factory supplied by your transformation context instead. */ + const updateMethod: (node: MethodDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, asteriskToken: AsteriskToken | undefined, name: PropertyName, questionToken: QuestionToken | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, body: Block | undefined) => MethodDeclaration; + /** @deprecated Use `factory.createConstructorDeclaration` or the factory supplied by your transformation context instead. */ + const createConstructor: (decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, parameters: readonly ParameterDeclaration[], body: Block | undefined) => ConstructorDeclaration; + /** @deprecated Use `factory.updateConstructorDeclaration` or the factory supplied by your transformation context instead. */ + const updateConstructor: (node: ConstructorDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, parameters: readonly ParameterDeclaration[], body: Block | undefined) => ConstructorDeclaration; + /** @deprecated Use `factory.createGetAccessorDeclaration` or the factory supplied by your transformation context instead. */ + const createGetAccessor: (decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier | StringLiteral | NumericLiteral | ComputedPropertyName | PrivateIdentifier, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, body: Block | undefined) => GetAccessorDeclaration; + /** @deprecated Use `factory.updateGetAccessorDeclaration` or the factory supplied by your transformation context instead. */ + const updateGetAccessor: (node: GetAccessorDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: PropertyName, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, body: Block | undefined) => GetAccessorDeclaration; + /** @deprecated Use `factory.createSetAccessorDeclaration` or the factory supplied by your transformation context instead. */ + const createSetAccessor: (decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier | StringLiteral | NumericLiteral | ComputedPropertyName | PrivateIdentifier, parameters: readonly ParameterDeclaration[], body: Block | undefined) => SetAccessorDeclaration; + /** @deprecated Use `factory.updateSetAccessorDeclaration` or the factory supplied by your transformation context instead. */ + const updateSetAccessor: (node: SetAccessorDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: PropertyName, parameters: readonly ParameterDeclaration[], body: Block | undefined) => SetAccessorDeclaration; + /** @deprecated Use `factory.createCallSignature` or the factory supplied by your transformation context instead. */ + const createCallSignature: (typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined) => CallSignatureDeclaration; + /** @deprecated Use `factory.updateCallSignature` or the factory supplied by your transformation context instead. */ + const updateCallSignature: (node: CallSignatureDeclaration, typeParameters: NodeArray | undefined, parameters: NodeArray, type: TypeNode | undefined) => CallSignatureDeclaration; + /** @deprecated Use `factory.createConstructSignature` or the factory supplied by your transformation context instead. */ + const createConstructSignature: (typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined) => ConstructSignatureDeclaration; + /** @deprecated Use `factory.updateConstructSignature` or the factory supplied by your transformation context instead. */ + const updateConstructSignature: (node: ConstructSignatureDeclaration, typeParameters: NodeArray | undefined, parameters: NodeArray, type: TypeNode | undefined) => ConstructSignatureDeclaration; + /** @deprecated Use `factory.updateIndexSignature` or the factory supplied by your transformation context instead. */ + const updateIndexSignature: (node: IndexSignatureDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode) => IndexSignatureDeclaration; + /** @deprecated Use `factory.createKeywordTypeNode` or the factory supplied by your transformation context instead. */ + const createKeywordTypeNode: (kind: TKind) => KeywordTypeNode; + /** @deprecated Use `factory.createTypePredicateNode` or the factory supplied by your transformation context instead. */ + const createTypePredicateNodeWithModifier: (assertsModifier: AssertsKeyword | undefined, parameterName: string | Identifier | ThisTypeNode, type: TypeNode | undefined) => TypePredicateNode; + /** @deprecated Use `factory.updateTypePredicateNode` or the factory supplied by your transformation context instead. */ + const updateTypePredicateNodeWithModifier: (node: TypePredicateNode, assertsModifier: AssertsKeyword | undefined, parameterName: Identifier | ThisTypeNode, type: TypeNode | undefined) => TypePredicateNode; + /** @deprecated Use `factory.createTypeReferenceNode` or the factory supplied by your transformation context instead. */ + const createTypeReferenceNode: (typeName: string | Identifier | QualifiedName, typeArguments?: readonly TypeNode[] | undefined) => TypeReferenceNode; + /** @deprecated Use `factory.updateTypeReferenceNode` or the factory supplied by your transformation context instead. */ + const updateTypeReferenceNode: (node: TypeReferenceNode, typeName: EntityName, typeArguments: NodeArray | undefined) => TypeReferenceNode; + /** @deprecated Use `factory.createFunctionTypeNode` or the factory supplied by your transformation context instead. */ + const createFunctionTypeNode: (typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode) => FunctionTypeNode; + /** @deprecated Use `factory.updateFunctionTypeNode` or the factory supplied by your transformation context instead. */ + const updateFunctionTypeNode: (node: FunctionTypeNode, typeParameters: NodeArray | undefined, parameters: NodeArray, type: TypeNode) => FunctionTypeNode; + /** @deprecated Use `factory.createConstructorTypeNode` or the factory supplied by your transformation context instead. */ + const createConstructorTypeNode: (typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode) => ConstructorTypeNode; + /** @deprecated Use `factory.updateConstructorTypeNode` or the factory supplied by your transformation context instead. */ + const updateConstructorTypeNode: (node: ConstructorTypeNode, typeParameters: NodeArray | undefined, parameters: NodeArray, type: TypeNode) => ConstructorTypeNode; + /** @deprecated Use `factory.createTypeQueryNode` or the factory supplied by your transformation context instead. */ + const createTypeQueryNode: (exprName: EntityName) => TypeQueryNode; + /** @deprecated Use `factory.updateTypeQueryNode` or the factory supplied by your transformation context instead. */ + const updateTypeQueryNode: (node: TypeQueryNode, exprName: EntityName) => TypeQueryNode; + /** @deprecated Use `factory.createTypeLiteralNode` or the factory supplied by your transformation context instead. */ + const createTypeLiteralNode: (members: readonly TypeElement[] | undefined) => TypeLiteralNode; + /** @deprecated Use `factory.updateTypeLiteralNode` or the factory supplied by your transformation context instead. */ + const updateTypeLiteralNode: (node: TypeLiteralNode, members: NodeArray) => TypeLiteralNode; + /** @deprecated Use `factory.createArrayTypeNode` or the factory supplied by your transformation context instead. */ + const createArrayTypeNode: (elementType: TypeNode) => ArrayTypeNode; + /** @deprecated Use `factory.updateArrayTypeNode` or the factory supplied by your transformation context instead. */ + const updateArrayTypeNode: (node: ArrayTypeNode, elementType: TypeNode) => ArrayTypeNode; + /** @deprecated Use `factory.createTupleTypeNode` or the factory supplied by your transformation context instead. */ + const createTupleTypeNode: (elements: readonly (TypeNode | NamedTupleMember)[]) => TupleTypeNode; + /** @deprecated Use `factory.updateTupleTypeNode` or the factory supplied by your transformation context instead. */ + const updateTupleTypeNode: (node: TupleTypeNode, elements: readonly (TypeNode | NamedTupleMember)[]) => TupleTypeNode; + /** @deprecated Use `factory.createOptionalTypeNode` or the factory supplied by your transformation context instead. */ + const createOptionalTypeNode: (type: TypeNode) => OptionalTypeNode; + /** @deprecated Use `factory.updateOptionalTypeNode` or the factory supplied by your transformation context instead. */ + const updateOptionalTypeNode: (node: OptionalTypeNode, type: TypeNode) => OptionalTypeNode; + /** @deprecated Use `factory.createRestTypeNode` or the factory supplied by your transformation context instead. */ + const createRestTypeNode: (type: TypeNode) => RestTypeNode; + /** @deprecated Use `factory.updateRestTypeNode` or the factory supplied by your transformation context instead. */ + const updateRestTypeNode: (node: RestTypeNode, type: TypeNode) => RestTypeNode; + /** @deprecated Use `factory.createUnionTypeNode` or the factory supplied by your transformation context instead. */ + const createUnionTypeNode: (types: readonly TypeNode[]) => UnionTypeNode; + /** @deprecated Use `factory.updateUnionTypeNode` or the factory supplied by your transformation context instead. */ + const updateUnionTypeNode: (node: UnionTypeNode, types: NodeArray) => UnionTypeNode; + /** @deprecated Use `factory.createIntersectionTypeNode` or the factory supplied by your transformation context instead. */ + const createIntersectionTypeNode: (types: readonly TypeNode[]) => IntersectionTypeNode; + /** @deprecated Use `factory.updateIntersectionTypeNode` or the factory supplied by your transformation context instead. */ + const updateIntersectionTypeNode: (node: IntersectionTypeNode, types: NodeArray) => IntersectionTypeNode; + /** @deprecated Use `factory.createConditionalTypeNode` or the factory supplied by your transformation context instead. */ + const createConditionalTypeNode: (checkType: TypeNode, extendsType: TypeNode, trueType: TypeNode, falseType: TypeNode) => ConditionalTypeNode; + /** @deprecated Use `factory.updateConditionalTypeNode` or the factory supplied by your transformation context instead. */ + const updateConditionalTypeNode: (node: ConditionalTypeNode, checkType: TypeNode, extendsType: TypeNode, trueType: TypeNode, falseType: TypeNode) => ConditionalTypeNode; + /** @deprecated Use `factory.createInferTypeNode` or the factory supplied by your transformation context instead. */ + const createInferTypeNode: (typeParameter: TypeParameterDeclaration) => InferTypeNode; + /** @deprecated Use `factory.updateInferTypeNode` or the factory supplied by your transformation context instead. */ + const updateInferTypeNode: (node: InferTypeNode, typeParameter: TypeParameterDeclaration) => InferTypeNode; + /** @deprecated Use `factory.createImportTypeNode` or the factory supplied by your transformation context instead. */ + const createImportTypeNode: (argument: TypeNode, qualifier?: Identifier | QualifiedName | undefined, typeArguments?: readonly TypeNode[] | undefined, isTypeOf?: boolean | undefined) => ImportTypeNode; + /** @deprecated Use `factory.updateImportTypeNode` or the factory supplied by your transformation context instead. */ + const updateImportTypeNode: (node: ImportTypeNode, argument: TypeNode, qualifier: Identifier | QualifiedName | undefined, typeArguments: readonly TypeNode[] | undefined, isTypeOf?: boolean | undefined) => ImportTypeNode; + /** @deprecated Use `factory.createParenthesizedType` or the factory supplied by your transformation context instead. */ + const createParenthesizedType: (type: TypeNode) => ParenthesizedTypeNode; + /** @deprecated Use `factory.updateParenthesizedType` or the factory supplied by your transformation context instead. */ + const updateParenthesizedType: (node: ParenthesizedTypeNode, type: TypeNode) => ParenthesizedTypeNode; + /** @deprecated Use `factory.createThisTypeNode` or the factory supplied by your transformation context instead. */ + const createThisTypeNode: () => ThisTypeNode; + /** @deprecated Use `factory.updateTypeOperatorNode` or the factory supplied by your transformation context instead. */ + const updateTypeOperatorNode: (node: TypeOperatorNode, type: TypeNode) => TypeOperatorNode; + /** @deprecated Use `factory.createIndexedAccessTypeNode` or the factory supplied by your transformation context instead. */ + const createIndexedAccessTypeNode: (objectType: TypeNode, indexType: TypeNode) => IndexedAccessTypeNode; + /** @deprecated Use `factory.updateIndexedAccessTypeNode` or the factory supplied by your transformation context instead. */ + const updateIndexedAccessTypeNode: (node: IndexedAccessTypeNode, objectType: TypeNode, indexType: TypeNode) => IndexedAccessTypeNode; + /** @deprecated Use `factory.createMappedTypeNode` or the factory supplied by your transformation context instead. */ + const createMappedTypeNode: (readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined) => MappedTypeNode; + /** @deprecated Use `factory.updateMappedTypeNode` or the factory supplied by your transformation context instead. */ + const updateMappedTypeNode: (node: MappedTypeNode, readonlyToken: ReadonlyKeyword | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, nameType: TypeNode | undefined, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined) => MappedTypeNode; + /** @deprecated Use `factory.createLiteralTypeNode` or the factory supplied by your transformation context instead. */ + const createLiteralTypeNode: (literal: LiteralExpression | TrueLiteral | FalseLiteral | PrefixUnaryExpression | NullLiteral) => LiteralTypeNode; + /** @deprecated Use `factory.updateLiteralTypeNode` or the factory supplied by your transformation context instead. */ + const updateLiteralTypeNode: (node: LiteralTypeNode, literal: LiteralExpression | TrueLiteral | FalseLiteral | PrefixUnaryExpression | NullLiteral) => LiteralTypeNode; + /** @deprecated Use `factory.createObjectBindingPattern` or the factory supplied by your transformation context instead. */ + const createObjectBindingPattern: (elements: readonly BindingElement[]) => ObjectBindingPattern; + /** @deprecated Use `factory.updateObjectBindingPattern` or the factory supplied by your transformation context instead. */ + const updateObjectBindingPattern: (node: ObjectBindingPattern, elements: readonly BindingElement[]) => ObjectBindingPattern; + /** @deprecated Use `factory.createArrayBindingPattern` or the factory supplied by your transformation context instead. */ + const createArrayBindingPattern: (elements: readonly ArrayBindingElement[]) => ArrayBindingPattern; + /** @deprecated Use `factory.updateArrayBindingPattern` or the factory supplied by your transformation context instead. */ + const updateArrayBindingPattern: (node: ArrayBindingPattern, elements: readonly ArrayBindingElement[]) => ArrayBindingPattern; + /** @deprecated Use `factory.createBindingElement` or the factory supplied by your transformation context instead. */ + const createBindingElement: (dotDotDotToken: DotDotDotToken | undefined, propertyName: string | Identifier | StringLiteral | NumericLiteral | ComputedPropertyName | PrivateIdentifier | undefined, name: string | Identifier | ObjectBindingPattern | ArrayBindingPattern, initializer?: Expression | undefined) => BindingElement; + /** @deprecated Use `factory.updateBindingElement` or the factory supplied by your transformation context instead. */ + const updateBindingElement: (node: BindingElement, dotDotDotToken: DotDotDotToken | undefined, propertyName: Identifier | StringLiteral | NumericLiteral | ComputedPropertyName | PrivateIdentifier | undefined, name: BindingName, initializer: Expression | undefined) => BindingElement; + /** @deprecated Use `factory.createArrayLiteral` or the factory supplied by your transformation context instead. */ + const createArrayLiteral: (elements?: readonly Expression[] | undefined, multiLine?: boolean | undefined) => ArrayLiteralExpression; + /** @deprecated Use `factory.updateArrayLiteral` or the factory supplied by your transformation context instead. */ + const updateArrayLiteral: (node: ArrayLiteralExpression, elements: readonly Expression[]) => ArrayLiteralExpression; + /** @deprecated Use `factory.createObjectLiteral` or the factory supplied by your transformation context instead. */ + const createObjectLiteral: (properties?: readonly ObjectLiteralElementLike[] | undefined, multiLine?: boolean | undefined) => ObjectLiteralExpression; + /** @deprecated Use `factory.updateObjectLiteral` or the factory supplied by your transformation context instead. */ + const updateObjectLiteral: (node: ObjectLiteralExpression, properties: readonly ObjectLiteralElementLike[]) => ObjectLiteralExpression; + /** @deprecated Use `factory.createPropertyAccess` or the factory supplied by your transformation context instead. */ + const createPropertyAccess: (expression: Expression, name: string | Identifier | PrivateIdentifier) => PropertyAccessExpression; + /** @deprecated Use `factory.updatePropertyAccess` or the factory supplied by your transformation context instead. */ + const updatePropertyAccess: (node: PropertyAccessExpression, expression: Expression, name: Identifier | PrivateIdentifier) => PropertyAccessExpression; + /** @deprecated Use `factory.createPropertyAccessChain` or the factory supplied by your transformation context instead. */ + const createPropertyAccessChain: (expression: Expression, questionDotToken: QuestionDotToken | undefined, name: string | Identifier | PrivateIdentifier) => PropertyAccessChain; + /** @deprecated Use `factory.updatePropertyAccessChain` or the factory supplied by your transformation context instead. */ + const updatePropertyAccessChain: (node: PropertyAccessChain, expression: Expression, questionDotToken: QuestionDotToken | undefined, name: Identifier | PrivateIdentifier) => PropertyAccessChain; + /** @deprecated Use `factory.createElementAccess` or the factory supplied by your transformation context instead. */ + const createElementAccess: (expression: Expression, index: number | Expression) => ElementAccessExpression; + /** @deprecated Use `factory.updateElementAccess` or the factory supplied by your transformation context instead. */ + const updateElementAccess: (node: ElementAccessExpression, expression: Expression, argumentExpression: Expression) => ElementAccessExpression; + /** @deprecated Use `factory.createElementAccessChain` or the factory supplied by your transformation context instead. */ + const createElementAccessChain: (expression: Expression, questionDotToken: QuestionDotToken | undefined, index: number | Expression) => ElementAccessChain; + /** @deprecated Use `factory.updateElementAccessChain` or the factory supplied by your transformation context instead. */ + const updateElementAccessChain: (node: ElementAccessChain, expression: Expression, questionDotToken: QuestionDotToken | undefined, argumentExpression: Expression) => ElementAccessChain; + /** @deprecated Use `factory.createCall` or the factory supplied by your transformation context instead. */ + const createCall: (expression: Expression, typeArguments: readonly TypeNode[] | undefined, argumentsArray: readonly Expression[] | undefined) => CallExpression; + /** @deprecated Use `factory.updateCall` or the factory supplied by your transformation context instead. */ + const updateCall: (node: CallExpression, expression: Expression, typeArguments: readonly TypeNode[] | undefined, argumentsArray: readonly Expression[]) => CallExpression; + /** @deprecated Use `factory.createCallChain` or the factory supplied by your transformation context instead. */ + const createCallChain: (expression: Expression, questionDotToken: QuestionDotToken | undefined, typeArguments: readonly TypeNode[] | undefined, argumentsArray: readonly Expression[] | undefined) => CallChain; + /** @deprecated Use `factory.updateCallChain` or the factory supplied by your transformation context instead. */ + const updateCallChain: (node: CallChain, expression: Expression, questionDotToken: QuestionDotToken | undefined, typeArguments: readonly TypeNode[] | undefined, argumentsArray: readonly Expression[]) => CallChain; + /** @deprecated Use `factory.createNew` or the factory supplied by your transformation context instead. */ + const createNew: (expression: Expression, typeArguments: readonly TypeNode[] | undefined, argumentsArray: readonly Expression[] | undefined) => NewExpression; + /** @deprecated Use `factory.updateNew` or the factory supplied by your transformation context instead. */ + const updateNew: (node: NewExpression, expression: Expression, typeArguments: readonly TypeNode[] | undefined, argumentsArray: readonly Expression[] | undefined) => NewExpression; + /** @deprecated Use `factory.createTypeAssertion` or the factory supplied by your transformation context instead. */ + const createTypeAssertion: (type: TypeNode, expression: Expression) => TypeAssertion; + /** @deprecated Use `factory.updateTypeAssertion` or the factory supplied by your transformation context instead. */ + const updateTypeAssertion: (node: TypeAssertion, type: TypeNode, expression: Expression) => TypeAssertion; + /** @deprecated Use `factory.createParen` or the factory supplied by your transformation context instead. */ + const createParen: (expression: Expression) => ParenthesizedExpression; + /** @deprecated Use `factory.updateParen` or the factory supplied by your transformation context instead. */ + const updateParen: (node: ParenthesizedExpression, expression: Expression) => ParenthesizedExpression; + /** @deprecated Use `factory.createFunctionExpression` or the factory supplied by your transformation context instead. */ + const createFunctionExpression: (modifiers: readonly Modifier[] | undefined, asteriskToken: AsteriskToken | undefined, name: string | Identifier | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[] | undefined, type: TypeNode | undefined, body: Block) => FunctionExpression; + /** @deprecated Use `factory.updateFunctionExpression` or the factory supplied by your transformation context instead. */ + const updateFunctionExpression: (node: FunctionExpression, modifiers: readonly Modifier[] | undefined, asteriskToken: AsteriskToken | undefined, name: Identifier | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, body: Block) => FunctionExpression; + /** @deprecated Use `factory.createDelete` or the factory supplied by your transformation context instead. */ + const createDelete: (expression: Expression) => DeleteExpression; + /** @deprecated Use `factory.updateDelete` or the factory supplied by your transformation context instead. */ + const updateDelete: (node: DeleteExpression, expression: Expression) => DeleteExpression; + /** @deprecated Use `factory.createTypeOf` or the factory supplied by your transformation context instead. */ + const createTypeOf: (expression: Expression) => TypeOfExpression; + /** @deprecated Use `factory.updateTypeOf` or the factory supplied by your transformation context instead. */ + const updateTypeOf: (node: TypeOfExpression, expression: Expression) => TypeOfExpression; + /** @deprecated Use `factory.createVoid` or the factory supplied by your transformation context instead. */ + const createVoid: (expression: Expression) => VoidExpression; + /** @deprecated Use `factory.updateVoid` or the factory supplied by your transformation context instead. */ + const updateVoid: (node: VoidExpression, expression: Expression) => VoidExpression; + /** @deprecated Use `factory.createAwait` or the factory supplied by your transformation context instead. */ + const createAwait: (expression: Expression) => AwaitExpression; + /** @deprecated Use `factory.updateAwait` or the factory supplied by your transformation context instead. */ + const updateAwait: (node: AwaitExpression, expression: Expression) => AwaitExpression; + /** @deprecated Use `factory.createPrefix` or the factory supplied by your transformation context instead. */ + const createPrefix: (operator: PrefixUnaryOperator, operand: Expression) => PrefixUnaryExpression; + /** @deprecated Use `factory.updatePrefix` or the factory supplied by your transformation context instead. */ + const updatePrefix: (node: PrefixUnaryExpression, operand: Expression) => PrefixUnaryExpression; + /** @deprecated Use `factory.createPostfix` or the factory supplied by your transformation context instead. */ + const createPostfix: (operand: Expression, operator: PostfixUnaryOperator) => PostfixUnaryExpression; + /** @deprecated Use `factory.updatePostfix` or the factory supplied by your transformation context instead. */ + const updatePostfix: (node: PostfixUnaryExpression, operand: Expression) => PostfixUnaryExpression; + /** @deprecated Use `factory.createBinary` or the factory supplied by your transformation context instead. */ + const createBinary: (left: Expression, operator: SyntaxKind.CommaToken | SyntaxKind.LessThanToken | SyntaxKind.GreaterThanToken | SyntaxKind.LessThanEqualsToken | SyntaxKind.GreaterThanEqualsToken | SyntaxKind.EqualsEqualsToken | SyntaxKind.ExclamationEqualsToken | SyntaxKind.EqualsEqualsEqualsToken | SyntaxKind.ExclamationEqualsEqualsToken | SyntaxKind.PlusToken | SyntaxKind.MinusToken | SyntaxKind.AsteriskToken | SyntaxKind.AsteriskAsteriskToken | SyntaxKind.SlashToken | SyntaxKind.PercentToken | SyntaxKind.LessThanLessThanToken | SyntaxKind.GreaterThanGreaterThanToken | SyntaxKind.GreaterThanGreaterThanGreaterThanToken | SyntaxKind.AmpersandToken | SyntaxKind.BarToken | SyntaxKind.CaretToken | SyntaxKind.AmpersandAmpersandToken | SyntaxKind.BarBarToken | SyntaxKind.QuestionQuestionToken | SyntaxKind.EqualsToken | SyntaxKind.PlusEqualsToken | SyntaxKind.MinusEqualsToken | SyntaxKind.AsteriskEqualsToken | SyntaxKind.AsteriskAsteriskEqualsToken | SyntaxKind.SlashEqualsToken | SyntaxKind.PercentEqualsToken | SyntaxKind.LessThanLessThanEqualsToken | SyntaxKind.GreaterThanGreaterThanEqualsToken | SyntaxKind.GreaterThanGreaterThanGreaterThanEqualsToken | SyntaxKind.AmpersandEqualsToken | SyntaxKind.BarEqualsToken | SyntaxKind.BarBarEqualsToken | SyntaxKind.AmpersandAmpersandEqualsToken | SyntaxKind.QuestionQuestionEqualsToken | SyntaxKind.CaretEqualsToken | SyntaxKind.InKeyword | SyntaxKind.InstanceOfKeyword | BinaryOperatorToken, right: Expression) => BinaryExpression; + /** @deprecated Use `factory.updateConditional` or the factory supplied by your transformation context instead. */ + const updateConditional: (node: ConditionalExpression, condition: Expression, questionToken: QuestionToken, whenTrue: Expression, colonToken: ColonToken, whenFalse: Expression) => ConditionalExpression; + /** @deprecated Use `factory.createTemplateExpression` or the factory supplied by your transformation context instead. */ + const createTemplateExpression: (head: TemplateHead, templateSpans: readonly TemplateSpan[]) => TemplateExpression; + /** @deprecated Use `factory.updateTemplateExpression` or the factory supplied by your transformation context instead. */ + const updateTemplateExpression: (node: TemplateExpression, head: TemplateHead, templateSpans: readonly TemplateSpan[]) => TemplateExpression; + /** @deprecated Use `factory.createTemplateHead` or the factory supplied by your transformation context instead. */ + const createTemplateHead: { + (text: string, rawText?: string | undefined, templateFlags?: TokenFlags | undefined): TemplateHead; + (text: string | undefined, rawText: string, templateFlags?: TokenFlags | undefined): TemplateHead; + }; + /** @deprecated Use `factory.createTemplateMiddle` or the factory supplied by your transformation context instead. */ + const createTemplateMiddle: { + (text: string, rawText?: string | undefined, templateFlags?: TokenFlags | undefined): TemplateMiddle; + (text: string | undefined, rawText: string, templateFlags?: TokenFlags | undefined): TemplateMiddle; + }; + /** @deprecated Use `factory.createTemplateTail` or the factory supplied by your transformation context instead. */ + const createTemplateTail: { + (text: string, rawText?: string | undefined, templateFlags?: TokenFlags | undefined): TemplateTail; + (text: string | undefined, rawText: string, templateFlags?: TokenFlags | undefined): TemplateTail; + }; + /** @deprecated Use `factory.createNoSubstitutionTemplateLiteral` or the factory supplied by your transformation context instead. */ + const createNoSubstitutionTemplateLiteral: { + (text: string, rawText?: string | undefined): NoSubstitutionTemplateLiteral; + (text: string | undefined, rawText: string): NoSubstitutionTemplateLiteral; + }; + /** @deprecated Use `factory.updateYield` or the factory supplied by your transformation context instead. */ + const updateYield: (node: YieldExpression, asteriskToken: AsteriskToken | undefined, expression: Expression | undefined) => YieldExpression; + /** @deprecated Use `factory.createSpread` or the factory supplied by your transformation context instead. */ + const createSpread: (expression: Expression) => SpreadElement; + /** @deprecated Use `factory.updateSpread` or the factory supplied by your transformation context instead. */ + const updateSpread: (node: SpreadElement, expression: Expression) => SpreadElement; + /** @deprecated Use `factory.createOmittedExpression` or the factory supplied by your transformation context instead. */ + const createOmittedExpression: () => OmittedExpression; + /** @deprecated Use `factory.createAsExpression` or the factory supplied by your transformation context instead. */ + const createAsExpression: (expression: Expression, type: TypeNode) => AsExpression; + /** @deprecated Use `factory.updateAsExpression` or the factory supplied by your transformation context instead. */ + const updateAsExpression: (node: AsExpression, expression: Expression, type: TypeNode) => AsExpression; + /** @deprecated Use `factory.createNonNullExpression` or the factory supplied by your transformation context instead. */ + const createNonNullExpression: (expression: Expression) => NonNullExpression; + /** @deprecated Use `factory.updateNonNullExpression` or the factory supplied by your transformation context instead. */ + const updateNonNullExpression: (node: NonNullExpression, expression: Expression) => NonNullExpression; + /** @deprecated Use `factory.createNonNullChain` or the factory supplied by your transformation context instead. */ + const createNonNullChain: (expression: Expression) => NonNullChain; + /** @deprecated Use `factory.updateNonNullChain` or the factory supplied by your transformation context instead. */ + const updateNonNullChain: (node: NonNullChain, expression: Expression) => NonNullChain; + /** @deprecated Use `factory.createMetaProperty` or the factory supplied by your transformation context instead. */ + const createMetaProperty: (keywordToken: SyntaxKind.ImportKeyword | SyntaxKind.NewKeyword, name: Identifier) => MetaProperty; + /** @deprecated Use `factory.updateMetaProperty` or the factory supplied by your transformation context instead. */ + const updateMetaProperty: (node: MetaProperty, name: Identifier) => MetaProperty; + /** @deprecated Use `factory.createTemplateSpan` or the factory supplied by your transformation context instead. */ + const createTemplateSpan: (expression: Expression, literal: TemplateMiddle | TemplateTail) => TemplateSpan; + /** @deprecated Use `factory.updateTemplateSpan` or the factory supplied by your transformation context instead. */ + const updateTemplateSpan: (node: TemplateSpan, expression: Expression, literal: TemplateMiddle | TemplateTail) => TemplateSpan; + /** @deprecated Use `factory.createSemicolonClassElement` or the factory supplied by your transformation context instead. */ + const createSemicolonClassElement: () => SemicolonClassElement; + /** @deprecated Use `factory.createBlock` or the factory supplied by your transformation context instead. */ + const createBlock: (statements: readonly Statement[], multiLine?: boolean | undefined) => Block; + /** @deprecated Use `factory.updateBlock` or the factory supplied by your transformation context instead. */ + const updateBlock: (node: Block, statements: readonly Statement[]) => Block; + /** @deprecated Use `factory.createVariableStatement` or the factory supplied by your transformation context instead. */ + const createVariableStatement: (modifiers: readonly Modifier[] | undefined, declarationList: VariableDeclarationList | readonly VariableDeclaration[]) => VariableStatement; + /** @deprecated Use `factory.updateVariableStatement` or the factory supplied by your transformation context instead. */ + const updateVariableStatement: (node: VariableStatement, modifiers: readonly Modifier[] | undefined, declarationList: VariableDeclarationList) => VariableStatement; + /** @deprecated Use `factory.createEmptyStatement` or the factory supplied by your transformation context instead. */ + const createEmptyStatement: () => EmptyStatement; + /** @deprecated Use `factory.createExpressionStatement` or the factory supplied by your transformation context instead. */ + const createExpressionStatement: (expression: Expression) => ExpressionStatement; + /** @deprecated Use `factory.updateExpressionStatement` or the factory supplied by your transformation context instead. */ + const updateExpressionStatement: (node: ExpressionStatement, expression: Expression) => ExpressionStatement; + /** @deprecated Use `factory.createExpressionStatement` or the factory supplied by your transformation context instead. */ + const createStatement: (expression: Expression) => ExpressionStatement; + /** @deprecated Use `factory.updateExpressionStatement` or the factory supplied by your transformation context instead. */ + const updateStatement: (node: ExpressionStatement, expression: Expression) => ExpressionStatement; + /** @deprecated Use `factory.createIf` or the factory supplied by your transformation context instead. */ + const createIf: (expression: Expression, thenStatement: Statement, elseStatement?: Statement | undefined) => IfStatement; + /** @deprecated Use `factory.updateIf` or the factory supplied by your transformation context instead. */ + const updateIf: (node: IfStatement, expression: Expression, thenStatement: Statement, elseStatement: Statement | undefined) => IfStatement; + /** @deprecated Use `factory.createDo` or the factory supplied by your transformation context instead. */ + const createDo: (statement: Statement, expression: Expression) => DoStatement; + /** @deprecated Use `factory.updateDo` or the factory supplied by your transformation context instead. */ + const updateDo: (node: DoStatement, statement: Statement, expression: Expression) => DoStatement; + /** @deprecated Use `factory.createWhile` or the factory supplied by your transformation context instead. */ + const createWhile: (expression: Expression, statement: Statement) => WhileStatement; + /** @deprecated Use `factory.updateWhile` or the factory supplied by your transformation context instead. */ + const updateWhile: (node: WhileStatement, expression: Expression, statement: Statement) => WhileStatement; + /** @deprecated Use `factory.createFor` or the factory supplied by your transformation context instead. */ + const createFor: (initializer: Expression | VariableDeclarationList | undefined, condition: Expression | undefined, incrementor: Expression | undefined, statement: Statement) => ForStatement; + /** @deprecated Use `factory.updateFor` or the factory supplied by your transformation context instead. */ + const updateFor: (node: ForStatement, initializer: Expression | VariableDeclarationList | undefined, condition: Expression | undefined, incrementor: Expression | undefined, statement: Statement) => ForStatement; + /** @deprecated Use `factory.createForIn` or the factory supplied by your transformation context instead. */ + const createForIn: (initializer: ForInitializer, expression: Expression, statement: Statement) => ForInStatement; + /** @deprecated Use `factory.updateForIn` or the factory supplied by your transformation context instead. */ + const updateForIn: (node: ForInStatement, initializer: ForInitializer, expression: Expression, statement: Statement) => ForInStatement; + /** @deprecated Use `factory.createForOf` or the factory supplied by your transformation context instead. */ + const createForOf: (awaitModifier: AwaitKeyword | undefined, initializer: ForInitializer, expression: Expression, statement: Statement) => ForOfStatement; + /** @deprecated Use `factory.updateForOf` or the factory supplied by your transformation context instead. */ + const updateForOf: (node: ForOfStatement, awaitModifier: AwaitKeyword | undefined, initializer: ForInitializer, expression: Expression, statement: Statement) => ForOfStatement; + /** @deprecated Use `factory.createContinue` or the factory supplied by your transformation context instead. */ + const createContinue: (label?: string | Identifier | undefined) => ContinueStatement; + /** @deprecated Use `factory.updateContinue` or the factory supplied by your transformation context instead. */ + const updateContinue: (node: ContinueStatement, label: Identifier | undefined) => ContinueStatement; + /** @deprecated Use `factory.createBreak` or the factory supplied by your transformation context instead. */ + const createBreak: (label?: string | Identifier | undefined) => BreakStatement; + /** @deprecated Use `factory.updateBreak` or the factory supplied by your transformation context instead. */ + const updateBreak: (node: BreakStatement, label: Identifier | undefined) => BreakStatement; + /** @deprecated Use `factory.createReturn` or the factory supplied by your transformation context instead. */ + const createReturn: (expression?: Expression | undefined) => ReturnStatement; + /** @deprecated Use `factory.updateReturn` or the factory supplied by your transformation context instead. */ + const updateReturn: (node: ReturnStatement, expression: Expression | undefined) => ReturnStatement; + /** @deprecated Use `factory.createWith` or the factory supplied by your transformation context instead. */ + const createWith: (expression: Expression, statement: Statement) => WithStatement; + /** @deprecated Use `factory.updateWith` or the factory supplied by your transformation context instead. */ + const updateWith: (node: WithStatement, expression: Expression, statement: Statement) => WithStatement; + /** @deprecated Use `factory.createSwitch` or the factory supplied by your transformation context instead. */ + const createSwitch: (expression: Expression, caseBlock: CaseBlock) => SwitchStatement; + /** @deprecated Use `factory.updateSwitch` or the factory supplied by your transformation context instead. */ + const updateSwitch: (node: SwitchStatement, expression: Expression, caseBlock: CaseBlock) => SwitchStatement; + /** @deprecated Use `factory.createLabel` or the factory supplied by your transformation context instead. */ + const createLabel: (label: string | Identifier, statement: Statement) => LabeledStatement; + /** @deprecated Use `factory.updateLabel` or the factory supplied by your transformation context instead. */ + const updateLabel: (node: LabeledStatement, label: Identifier, statement: Statement) => LabeledStatement; + /** @deprecated Use `factory.createThrow` or the factory supplied by your transformation context instead. */ + const createThrow: (expression: Expression) => ThrowStatement; + /** @deprecated Use `factory.updateThrow` or the factory supplied by your transformation context instead. */ + const updateThrow: (node: ThrowStatement, expression: Expression) => ThrowStatement; + /** @deprecated Use `factory.createTry` or the factory supplied by your transformation context instead. */ + const createTry: (tryBlock: Block, catchClause: CatchClause | undefined, finallyBlock: Block | undefined) => TryStatement; + /** @deprecated Use `factory.updateTry` or the factory supplied by your transformation context instead. */ + const updateTry: (node: TryStatement, tryBlock: Block, catchClause: CatchClause | undefined, finallyBlock: Block | undefined) => TryStatement; + /** @deprecated Use `factory.createDebuggerStatement` or the factory supplied by your transformation context instead. */ + const createDebuggerStatement: () => DebuggerStatement; + /** @deprecated Use `factory.createVariableDeclarationList` or the factory supplied by your transformation context instead. */ + const createVariableDeclarationList: (declarations: readonly VariableDeclaration[], flags?: NodeFlags | undefined) => VariableDeclarationList; + /** @deprecated Use `factory.updateVariableDeclarationList` or the factory supplied by your transformation context instead. */ + const updateVariableDeclarationList: (node: VariableDeclarationList, declarations: readonly VariableDeclaration[]) => VariableDeclarationList; + /** @deprecated Use `factory.createFunctionDeclaration` or the factory supplied by your transformation context instead. */ + const createFunctionDeclaration: (decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, asteriskToken: AsteriskToken | undefined, name: string | Identifier | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, body: Block | undefined) => FunctionDeclaration; + /** @deprecated Use `factory.updateFunctionDeclaration` or the factory supplied by your transformation context instead. */ + const updateFunctionDeclaration: (node: FunctionDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, asteriskToken: AsteriskToken | undefined, name: Identifier | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, body: Block | undefined) => FunctionDeclaration; + /** @deprecated Use `factory.createClassDeclaration` or the factory supplied by your transformation context instead. */ + const createClassDeclaration: (decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, heritageClauses: readonly HeritageClause[] | undefined, members: readonly ClassElement[]) => ClassDeclaration; + /** @deprecated Use `factory.updateClassDeclaration` or the factory supplied by your transformation context instead. */ + const updateClassDeclaration: (node: ClassDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: Identifier | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, heritageClauses: readonly HeritageClause[] | undefined, members: readonly ClassElement[]) => ClassDeclaration; + /** @deprecated Use `factory.createInterfaceDeclaration` or the factory supplied by your transformation context instead. */ + const createInterfaceDeclaration: (decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier, typeParameters: readonly TypeParameterDeclaration[] | undefined, heritageClauses: readonly HeritageClause[] | undefined, members: readonly TypeElement[]) => InterfaceDeclaration; + /** @deprecated Use `factory.updateInterfaceDeclaration` or the factory supplied by your transformation context instead. */ + const updateInterfaceDeclaration: (node: InterfaceDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: Identifier, typeParameters: readonly TypeParameterDeclaration[] | undefined, heritageClauses: readonly HeritageClause[] | undefined, members: readonly TypeElement[]) => InterfaceDeclaration; + /** @deprecated Use `factory.createTypeAliasDeclaration` or the factory supplied by your transformation context instead. */ + const createTypeAliasDeclaration: (decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier, typeParameters: readonly TypeParameterDeclaration[] | undefined, type: TypeNode) => TypeAliasDeclaration; + /** @deprecated Use `factory.updateTypeAliasDeclaration` or the factory supplied by your transformation context instead. */ + const updateTypeAliasDeclaration: (node: TypeAliasDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: Identifier, typeParameters: readonly TypeParameterDeclaration[] | undefined, type: TypeNode) => TypeAliasDeclaration; + /** @deprecated Use `factory.createEnumDeclaration` or the factory supplied by your transformation context instead. */ + const createEnumDeclaration: (decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier, members: readonly EnumMember[]) => EnumDeclaration; + /** @deprecated Use `factory.updateEnumDeclaration` or the factory supplied by your transformation context instead. */ + const updateEnumDeclaration: (node: EnumDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: Identifier, members: readonly EnumMember[]) => EnumDeclaration; + /** @deprecated Use `factory.createModuleDeclaration` or the factory supplied by your transformation context instead. */ + const createModuleDeclaration: (decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: ModuleName, body: Identifier | ModuleBlock | NamespaceDeclaration | JSDocNamespaceDeclaration | undefined, flags?: NodeFlags | undefined) => ModuleDeclaration; + /** @deprecated Use `factory.updateModuleDeclaration` or the factory supplied by your transformation context instead. */ + const updateModuleDeclaration: (node: ModuleDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: ModuleName, body: Identifier | ModuleBlock | NamespaceDeclaration | JSDocNamespaceDeclaration | undefined) => ModuleDeclaration; + /** @deprecated Use `factory.createModuleBlock` or the factory supplied by your transformation context instead. */ + const createModuleBlock: (statements: readonly Statement[]) => ModuleBlock; + /** @deprecated Use `factory.updateModuleBlock` or the factory supplied by your transformation context instead. */ + const updateModuleBlock: (node: ModuleBlock, statements: readonly Statement[]) => ModuleBlock; + /** @deprecated Use `factory.createCaseBlock` or the factory supplied by your transformation context instead. */ + const createCaseBlock: (clauses: readonly CaseOrDefaultClause[]) => CaseBlock; + /** @deprecated Use `factory.updateCaseBlock` or the factory supplied by your transformation context instead. */ + const updateCaseBlock: (node: CaseBlock, clauses: readonly CaseOrDefaultClause[]) => CaseBlock; + /** @deprecated Use `factory.createNamespaceExportDeclaration` or the factory supplied by your transformation context instead. */ + const createNamespaceExportDeclaration: (name: string | Identifier) => NamespaceExportDeclaration; + /** @deprecated Use `factory.updateNamespaceExportDeclaration` or the factory supplied by your transformation context instead. */ + const updateNamespaceExportDeclaration: (node: NamespaceExportDeclaration, name: Identifier) => NamespaceExportDeclaration; + /** @deprecated Use `factory.createImportEqualsDeclaration` or the factory supplied by your transformation context instead. */ + const createImportEqualsDeclaration: (decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier, moduleReference: ModuleReference) => ImportEqualsDeclaration; + /** @deprecated Use `factory.updateImportEqualsDeclaration` or the factory supplied by your transformation context instead. */ + const updateImportEqualsDeclaration: (node: ImportEqualsDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: Identifier, moduleReference: ModuleReference) => ImportEqualsDeclaration; + /** @deprecated Use `factory.createImportDeclaration` or the factory supplied by your transformation context instead. */ + const createImportDeclaration: (decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, importClause: ImportClause | undefined, moduleSpecifier: Expression) => ImportDeclaration; + /** @deprecated Use `factory.updateImportDeclaration` or the factory supplied by your transformation context instead. */ + const updateImportDeclaration: (node: ImportDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, importClause: ImportClause | undefined, moduleSpecifier: Expression) => ImportDeclaration; + /** @deprecated Use `factory.createNamespaceImport` or the factory supplied by your transformation context instead. */ + const createNamespaceImport: (name: Identifier) => NamespaceImport; + /** @deprecated Use `factory.updateNamespaceImport` or the factory supplied by your transformation context instead. */ + const updateNamespaceImport: (node: NamespaceImport, name: Identifier) => NamespaceImport; + /** @deprecated Use `factory.createNamedImports` or the factory supplied by your transformation context instead. */ + const createNamedImports: (elements: readonly ImportSpecifier[]) => NamedImports; + /** @deprecated Use `factory.updateNamedImports` or the factory supplied by your transformation context instead. */ + const updateNamedImports: (node: NamedImports, elements: readonly ImportSpecifier[]) => NamedImports; + /** @deprecated Use `factory.createImportSpecifier` or the factory supplied by your transformation context instead. */ + const createImportSpecifier: (propertyName: Identifier | undefined, name: Identifier) => ImportSpecifier; + /** @deprecated Use `factory.updateImportSpecifier` or the factory supplied by your transformation context instead. */ + const updateImportSpecifier: (node: ImportSpecifier, propertyName: Identifier | undefined, name: Identifier) => ImportSpecifier; + /** @deprecated Use `factory.createExportAssignment` or the factory supplied by your transformation context instead. */ + const createExportAssignment: (decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, isExportEquals: boolean | undefined, expression: Expression) => ExportAssignment; + /** @deprecated Use `factory.updateExportAssignment` or the factory supplied by your transformation context instead. */ + const updateExportAssignment: (node: ExportAssignment, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, expression: Expression) => ExportAssignment; + /** @deprecated Use `factory.createNamedExports` or the factory supplied by your transformation context instead. */ + const createNamedExports: (elements: readonly ExportSpecifier[]) => NamedExports; + /** @deprecated Use `factory.updateNamedExports` or the factory supplied by your transformation context instead. */ + const updateNamedExports: (node: NamedExports, elements: readonly ExportSpecifier[]) => NamedExports; + /** @deprecated Use `factory.createExportSpecifier` or the factory supplied by your transformation context instead. */ + const createExportSpecifier: (propertyName: string | Identifier | undefined, name: string | Identifier) => ExportSpecifier; + /** @deprecated Use `factory.updateExportSpecifier` or the factory supplied by your transformation context instead. */ + const updateExportSpecifier: (node: ExportSpecifier, propertyName: Identifier | undefined, name: Identifier) => ExportSpecifier; + /** @deprecated Use `factory.createExternalModuleReference` or the factory supplied by your transformation context instead. */ + const createExternalModuleReference: (expression: Expression) => ExternalModuleReference; + /** @deprecated Use `factory.updateExternalModuleReference` or the factory supplied by your transformation context instead. */ + const updateExternalModuleReference: (node: ExternalModuleReference, expression: Expression) => ExternalModuleReference; + /** @deprecated Use `factory.createJSDocTypeExpression` or the factory supplied by your transformation context instead. */ + const createJSDocTypeExpression: (type: TypeNode) => JSDocTypeExpression; + /** @deprecated Use `factory.createJSDocTypeTag` or the factory supplied by your transformation context instead. */ + const createJSDocTypeTag: (tagName: Identifier | undefined, typeExpression: JSDocTypeExpression, comment?: string | undefined) => JSDocTypeTag; + /** @deprecated Use `factory.createJSDocReturnTag` or the factory supplied by your transformation context instead. */ + const createJSDocReturnTag: (tagName: Identifier | undefined, typeExpression?: JSDocTypeExpression | undefined, comment?: string | undefined) => JSDocReturnTag; + /** @deprecated Use `factory.createJSDocThisTag` or the factory supplied by your transformation context instead. */ + const createJSDocThisTag: (tagName: Identifier | undefined, typeExpression: JSDocTypeExpression, comment?: string | undefined) => JSDocThisTag; + /** @deprecated Use `factory.createJSDocComment` or the factory supplied by your transformation context instead. */ + const createJSDocComment: (comment?: string | undefined, tags?: readonly JSDocTag[] | undefined) => JSDoc; + /** @deprecated Use `factory.createJSDocParameterTag` or the factory supplied by your transformation context instead. */ + const createJSDocParameterTag: (tagName: Identifier | undefined, name: EntityName, isBracketed: boolean, typeExpression?: JSDocTypeExpression | undefined, isNameFirst?: boolean | undefined, comment?: string | undefined) => JSDocParameterTag; + /** @deprecated Use `factory.createJSDocClassTag` or the factory supplied by your transformation context instead. */ + const createJSDocClassTag: (tagName: Identifier | undefined, comment?: string | undefined) => JSDocClassTag; + /** @deprecated Use `factory.createJSDocAugmentsTag` or the factory supplied by your transformation context instead. */ + const createJSDocAugmentsTag: (tagName: Identifier | undefined, className: ExpressionWithTypeArguments & { + readonly expression: Identifier | PropertyAccessEntityNameExpression; + }, comment?: string | undefined) => JSDocAugmentsTag; + /** @deprecated Use `factory.createJSDocEnumTag` or the factory supplied by your transformation context instead. */ + const createJSDocEnumTag: (tagName: Identifier | undefined, typeExpression: JSDocTypeExpression, comment?: string | undefined) => JSDocEnumTag; + /** @deprecated Use `factory.createJSDocTemplateTag` or the factory supplied by your transformation context instead. */ + const createJSDocTemplateTag: (tagName: Identifier | undefined, constraint: JSDocTypeExpression | undefined, typeParameters: readonly TypeParameterDeclaration[], comment?: string | undefined) => JSDocTemplateTag; + /** @deprecated Use `factory.createJSDocTypedefTag` or the factory supplied by your transformation context instead. */ + const createJSDocTypedefTag: (tagName: Identifier | undefined, typeExpression?: JSDocTypeLiteral | JSDocTypeExpression | undefined, fullName?: Identifier | JSDocNamespaceDeclaration | undefined, comment?: string | undefined) => JSDocTypedefTag; + /** @deprecated Use `factory.createJSDocCallbackTag` or the factory supplied by your transformation context instead. */ + const createJSDocCallbackTag: (tagName: Identifier | undefined, typeExpression: JSDocSignature, fullName?: Identifier | JSDocNamespaceDeclaration | undefined, comment?: string | undefined) => JSDocCallbackTag; + /** @deprecated Use `factory.createJSDocSignature` or the factory supplied by your transformation context instead. */ + const createJSDocSignature: (typeParameters: readonly JSDocTemplateTag[] | undefined, parameters: readonly JSDocParameterTag[], type?: JSDocReturnTag | undefined) => JSDocSignature; + /** @deprecated Use `factory.createJSDocPropertyTag` or the factory supplied by your transformation context instead. */ + const createJSDocPropertyTag: (tagName: Identifier | undefined, name: EntityName, isBracketed: boolean, typeExpression?: JSDocTypeExpression | undefined, isNameFirst?: boolean | undefined, comment?: string | undefined) => JSDocPropertyTag; + /** @deprecated Use `factory.createJSDocTypeLiteral` or the factory supplied by your transformation context instead. */ + const createJSDocTypeLiteral: (jsDocPropertyTags?: readonly JSDocPropertyLikeTag[] | undefined, isArrayType?: boolean | undefined) => JSDocTypeLiteral; + /** @deprecated Use `factory.createJSDocImplementsTag` or the factory supplied by your transformation context instead. */ + const createJSDocImplementsTag: (tagName: Identifier | undefined, className: ExpressionWithTypeArguments & { + readonly expression: Identifier | PropertyAccessEntityNameExpression; + }, comment?: string | undefined) => JSDocImplementsTag; + /** @deprecated Use `factory.createJSDocAuthorTag` or the factory supplied by your transformation context instead. */ + const createJSDocAuthorTag: (tagName: Identifier | undefined, comment?: string | undefined) => JSDocAuthorTag; + /** @deprecated Use `factory.createJSDocPublicTag` or the factory supplied by your transformation context instead. */ + const createJSDocPublicTag: (tagName: Identifier | undefined, comment?: string | undefined) => JSDocPublicTag; + /** @deprecated Use `factory.createJSDocPrivateTag` or the factory supplied by your transformation context instead. */ + const createJSDocPrivateTag: (tagName: Identifier | undefined, comment?: string | undefined) => JSDocPrivateTag; + /** @deprecated Use `factory.createJSDocProtectedTag` or the factory supplied by your transformation context instead. */ + const createJSDocProtectedTag: (tagName: Identifier | undefined, comment?: string | undefined) => JSDocProtectedTag; + /** @deprecated Use `factory.createJSDocReadonlyTag` or the factory supplied by your transformation context instead. */ + const createJSDocReadonlyTag: (tagName: Identifier | undefined, comment?: string | undefined) => JSDocReadonlyTag; + /** @deprecated Use `factory.createJSDocUnknownTag` or the factory supplied by your transformation context instead. */ + const createJSDocTag: (tagName: Identifier, comment?: string | undefined) => JSDocUnknownTag; + /** @deprecated Use `factory.createJsxElement` or the factory supplied by your transformation context instead. */ + const createJsxElement: (openingElement: JsxOpeningElement, children: readonly JsxChild[], closingElement: JsxClosingElement) => JsxElement; + /** @deprecated Use `factory.updateJsxElement` or the factory supplied by your transformation context instead. */ + const updateJsxElement: (node: JsxElement, openingElement: JsxOpeningElement, children: readonly JsxChild[], closingElement: JsxClosingElement) => JsxElement; + /** @deprecated Use `factory.createJsxSelfClosingElement` or the factory supplied by your transformation context instead. */ + const createJsxSelfClosingElement: (tagName: JsxTagNameExpression, typeArguments: readonly TypeNode[] | undefined, attributes: JsxAttributes) => JsxSelfClosingElement; + /** @deprecated Use `factory.updateJsxSelfClosingElement` or the factory supplied by your transformation context instead. */ + const updateJsxSelfClosingElement: (node: JsxSelfClosingElement, tagName: JsxTagNameExpression, typeArguments: readonly TypeNode[] | undefined, attributes: JsxAttributes) => JsxSelfClosingElement; + /** @deprecated Use `factory.createJsxOpeningElement` or the factory supplied by your transformation context instead. */ + const createJsxOpeningElement: (tagName: JsxTagNameExpression, typeArguments: readonly TypeNode[] | undefined, attributes: JsxAttributes) => JsxOpeningElement; + /** @deprecated Use `factory.updateJsxOpeningElement` or the factory supplied by your transformation context instead. */ + const updateJsxOpeningElement: (node: JsxOpeningElement, tagName: JsxTagNameExpression, typeArguments: readonly TypeNode[] | undefined, attributes: JsxAttributes) => JsxOpeningElement; + /** @deprecated Use `factory.createJsxClosingElement` or the factory supplied by your transformation context instead. */ + const createJsxClosingElement: (tagName: JsxTagNameExpression) => JsxClosingElement; + /** @deprecated Use `factory.updateJsxClosingElement` or the factory supplied by your transformation context instead. */ + const updateJsxClosingElement: (node: JsxClosingElement, tagName: JsxTagNameExpression) => JsxClosingElement; + /** @deprecated Use `factory.createJsxFragment` or the factory supplied by your transformation context instead. */ + const createJsxFragment: (openingFragment: JsxOpeningFragment, children: readonly JsxChild[], closingFragment: JsxClosingFragment) => JsxFragment; + /** @deprecated Use `factory.createJsxText` or the factory supplied by your transformation context instead. */ + const createJsxText: (text: string, containsOnlyTriviaWhiteSpaces?: boolean | undefined) => JsxText; + /** @deprecated Use `factory.updateJsxText` or the factory supplied by your transformation context instead. */ + const updateJsxText: (node: JsxText, text: string, containsOnlyTriviaWhiteSpaces?: boolean | undefined) => JsxText; + /** @deprecated Use `factory.createJsxOpeningFragment` or the factory supplied by your transformation context instead. */ + const createJsxOpeningFragment: () => JsxOpeningFragment; + /** @deprecated Use `factory.createJsxJsxClosingFragment` or the factory supplied by your transformation context instead. */ + const createJsxJsxClosingFragment: () => JsxClosingFragment; + /** @deprecated Use `factory.updateJsxFragment` or the factory supplied by your transformation context instead. */ + const updateJsxFragment: (node: JsxFragment, openingFragment: JsxOpeningFragment, children: readonly JsxChild[], closingFragment: JsxClosingFragment) => JsxFragment; + /** @deprecated Use `factory.createJsxAttribute` or the factory supplied by your transformation context instead. */ + const createJsxAttribute: (name: Identifier, initializer: StringLiteral | JsxExpression | undefined) => JsxAttribute; + /** @deprecated Use `factory.updateJsxAttribute` or the factory supplied by your transformation context instead. */ + const updateJsxAttribute: (node: JsxAttribute, name: Identifier, initializer: StringLiteral | JsxExpression | undefined) => JsxAttribute; + /** @deprecated Use `factory.createJsxAttributes` or the factory supplied by your transformation context instead. */ + const createJsxAttributes: (properties: readonly JsxAttributeLike[]) => JsxAttributes; + /** @deprecated Use `factory.updateJsxAttributes` or the factory supplied by your transformation context instead. */ + const updateJsxAttributes: (node: JsxAttributes, properties: readonly JsxAttributeLike[]) => JsxAttributes; + /** @deprecated Use `factory.createJsxSpreadAttribute` or the factory supplied by your transformation context instead. */ + const createJsxSpreadAttribute: (expression: Expression) => JsxSpreadAttribute; + /** @deprecated Use `factory.updateJsxSpreadAttribute` or the factory supplied by your transformation context instead. */ + const updateJsxSpreadAttribute: (node: JsxSpreadAttribute, expression: Expression) => JsxSpreadAttribute; + /** @deprecated Use `factory.createJsxExpression` or the factory supplied by your transformation context instead. */ + const createJsxExpression: (dotDotDotToken: DotDotDotToken | undefined, expression: Expression | undefined) => JsxExpression; + /** @deprecated Use `factory.updateJsxExpression` or the factory supplied by your transformation context instead. */ + const updateJsxExpression: (node: JsxExpression, expression: Expression | undefined) => JsxExpression; + /** @deprecated Use `factory.createCaseClause` or the factory supplied by your transformation context instead. */ + const createCaseClause: (expression: Expression, statements: readonly Statement[]) => CaseClause; + /** @deprecated Use `factory.updateCaseClause` or the factory supplied by your transformation context instead. */ + const updateCaseClause: (node: CaseClause, expression: Expression, statements: readonly Statement[]) => CaseClause; + /** @deprecated Use `factory.createDefaultClause` or the factory supplied by your transformation context instead. */ + const createDefaultClause: (statements: readonly Statement[]) => DefaultClause; + /** @deprecated Use `factory.updateDefaultClause` or the factory supplied by your transformation context instead. */ + const updateDefaultClause: (node: DefaultClause, statements: readonly Statement[]) => DefaultClause; + /** @deprecated Use `factory.createHeritageClause` or the factory supplied by your transformation context instead. */ + const createHeritageClause: (token: SyntaxKind.ExtendsKeyword | SyntaxKind.ImplementsKeyword, types: readonly ExpressionWithTypeArguments[]) => HeritageClause; + /** @deprecated Use `factory.updateHeritageClause` or the factory supplied by your transformation context instead. */ + const updateHeritageClause: (node: HeritageClause, types: readonly ExpressionWithTypeArguments[]) => HeritageClause; + /** @deprecated Use `factory.createCatchClause` or the factory supplied by your transformation context instead. */ + const createCatchClause: (variableDeclaration: string | VariableDeclaration | undefined, block: Block) => CatchClause; + /** @deprecated Use `factory.updateCatchClause` or the factory supplied by your transformation context instead. */ + const updateCatchClause: (node: CatchClause, variableDeclaration: VariableDeclaration | undefined, block: Block) => CatchClause; + /** @deprecated Use `factory.createPropertyAssignment` or the factory supplied by your transformation context instead. */ + const createPropertyAssignment: (name: string | Identifier | StringLiteral | NumericLiteral | ComputedPropertyName | PrivateIdentifier, initializer: Expression) => PropertyAssignment; + /** @deprecated Use `factory.updatePropertyAssignment` or the factory supplied by your transformation context instead. */ + const updatePropertyAssignment: (node: PropertyAssignment, name: PropertyName, initializer: Expression) => PropertyAssignment; + /** @deprecated Use `factory.createShorthandPropertyAssignment` or the factory supplied by your transformation context instead. */ + const createShorthandPropertyAssignment: (name: string | Identifier, objectAssignmentInitializer?: Expression | undefined) => ShorthandPropertyAssignment; + /** @deprecated Use `factory.updateShorthandPropertyAssignment` or the factory supplied by your transformation context instead. */ + const updateShorthandPropertyAssignment: (node: ShorthandPropertyAssignment, name: Identifier, objectAssignmentInitializer: Expression | undefined) => ShorthandPropertyAssignment; + /** @deprecated Use `factory.createSpreadAssignment` or the factory supplied by your transformation context instead. */ + const createSpreadAssignment: (expression: Expression) => SpreadAssignment; + /** @deprecated Use `factory.updateSpreadAssignment` or the factory supplied by your transformation context instead. */ + const updateSpreadAssignment: (node: SpreadAssignment, expression: Expression) => SpreadAssignment; + /** @deprecated Use `factory.createEnumMember` or the factory supplied by your transformation context instead. */ + const createEnumMember: (name: string | Identifier | StringLiteral | NumericLiteral | ComputedPropertyName | PrivateIdentifier, initializer?: Expression | undefined) => EnumMember; + /** @deprecated Use `factory.updateEnumMember` or the factory supplied by your transformation context instead. */ + const updateEnumMember: (node: EnumMember, name: PropertyName, initializer: Expression | undefined) => EnumMember; + /** @deprecated Use `factory.updateSourceFile` or the factory supplied by your transformation context instead. */ + const updateSourceFileNode: (node: SourceFile, statements: readonly Statement[], isDeclarationFile?: boolean | undefined, referencedFiles?: readonly FileReference[] | undefined, typeReferences?: readonly FileReference[] | undefined, hasNoDefaultLib?: boolean | undefined, libReferences?: readonly FileReference[] | undefined) => SourceFile; + /** @deprecated Use `factory.createNotEmittedStatement` or the factory supplied by your transformation context instead. */ + const createNotEmittedStatement: (original: Node) => NotEmittedStatement; + /** @deprecated Use `factory.createPartiallyEmittedExpression` or the factory supplied by your transformation context instead. */ + const createPartiallyEmittedExpression: (expression: Expression, original?: Node | undefined) => PartiallyEmittedExpression; + /** @deprecated Use `factory.updatePartiallyEmittedExpression` or the factory supplied by your transformation context instead. */ + const updatePartiallyEmittedExpression: (node: PartiallyEmittedExpression, expression: Expression) => PartiallyEmittedExpression; + /** @deprecated Use `factory.createCommaList` or the factory supplied by your transformation context instead. */ + const createCommaList: (elements: readonly Expression[]) => CommaListExpression; + /** @deprecated Use `factory.updateCommaList` or the factory supplied by your transformation context instead. */ + const updateCommaList: (node: CommaListExpression, elements: readonly Expression[]) => CommaListExpression; + /** @deprecated Use `factory.createBundle` or the factory supplied by your transformation context instead. */ + const createBundle: (sourceFiles: readonly SourceFile[], prepends?: readonly (UnparsedSource | InputFiles)[] | undefined) => Bundle; + /** @deprecated Use `factory.updateBundle` or the factory supplied by your transformation context instead. */ + const updateBundle: (node: Bundle, sourceFiles: readonly SourceFile[], prepends?: readonly (UnparsedSource | InputFiles)[] | undefined) => Bundle; + /** @deprecated Use `factory.createImmediatelyInvokedFunctionExpression` or the factory supplied by your transformation context instead. */ + const createImmediatelyInvokedFunctionExpression: { + (statements: readonly Statement[]): CallExpression; + (statements: readonly Statement[], param: ParameterDeclaration, paramValue: Expression): CallExpression; + }; + /** @deprecated Use `factory.createImmediatelyInvokedArrowFunction` or the factory supplied by your transformation context instead. */ + const createImmediatelyInvokedArrowFunction: { + (statements: readonly Statement[]): CallExpression; + (statements: readonly Statement[], param: ParameterDeclaration, paramValue: Expression): CallExpression; + }; + /** @deprecated Use `factory.createVoidZero` or the factory supplied by your transformation context instead. */ + const createVoidZero: () => VoidExpression; + /** @deprecated Use `factory.createExportDefault` or the factory supplied by your transformation context instead. */ + const createExportDefault: (expression: Expression) => ExportAssignment; + /** @deprecated Use `factory.createExternalModuleExport` or the factory supplied by your transformation context instead. */ + const createExternalModuleExport: (exportName: Identifier) => ExportDeclaration; + /** @deprecated Use `factory.createNamespaceExport` or the factory supplied by your transformation context instead. */ + const createNamespaceExport: (name: Identifier) => NamespaceExport; + /** @deprecated Use `factory.updateNamespaceExport` or the factory supplied by your transformation context instead. */ + const updateNamespaceExport: (node: NamespaceExport, name: Identifier) => NamespaceExport; + /** @deprecated Use `factory.createToken` or the factory supplied by your transformation context instead. */ + const createToken: (kind: TKind) => Token; + /** @deprecated Use `factory.createIdentifier` or the factory supplied by your transformation context instead. */ + const createIdentifier: (text: string) => Identifier; + /** @deprecated Use `factory.createTempVariable` or the factory supplied by your transformation context instead. */ + const createTempVariable: (recordTempVariable: ((node: Identifier) => void) | undefined) => Identifier; + /** @deprecated Use `factory.getGeneratedNameForNode` or the factory supplied by your transformation context instead. */ + const getGeneratedNameForNode: (node: Node | undefined) => Identifier; + /** @deprecated Use `factory.createUniqueName(text, GeneratedIdentifierFlags.Optimistic)` or the factory supplied by your transformation context instead. */ + const createOptimisticUniqueName: (text: string) => Identifier; + /** @deprecated Use `factory.createUniqueName(text, GeneratedIdentifierFlags.Optimistic | GeneratedIdentifierFlags.FileLevel)` or the factory supplied by your transformation context instead. */ + const createFileLevelUniqueName: (text: string) => Identifier; + /** @deprecated Use `factory.createIndexSignature` or the factory supplied by your transformation context instead. */ + const createIndexSignature: (decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode) => IndexSignatureDeclaration; + /** @deprecated Use `factory.createTypePredicateNode` or the factory supplied by your transformation context instead. */ + const createTypePredicateNode: (parameterName: Identifier | ThisTypeNode | string, type: TypeNode) => TypePredicateNode; + /** @deprecated Use `factory.updateTypePredicateNode` or the factory supplied by your transformation context instead. */ + const updateTypePredicateNode: (node: TypePredicateNode, parameterName: Identifier | ThisTypeNode, type: TypeNode) => TypePredicateNode; + /** @deprecated Use `factory.createStringLiteral`, `factory.createStringLiteralFromNode`, `factory.createNumericLiteral`, `factory.createBigIntLiteral`, `factory.createTrue`, `factory.createFalse`, or the factory supplied by your transformation context instead. */ + const createLiteral: { + (value: string | StringLiteral | NoSubstitutionTemplateLiteral | NumericLiteral | Identifier): StringLiteral; + (value: number | PseudoBigInt): NumericLiteral; + (value: boolean): BooleanLiteral; + (value: string | number | PseudoBigInt | boolean): PrimaryExpression; + }; + /** @deprecated Use `factory.createMethodSignature` or the factory supplied by your transformation context instead. */ + const createMethodSignature: (typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, name: string | PropertyName, questionToken: QuestionToken | undefined) => MethodSignature; + /** @deprecated Use `factory.updateMethodSignature` or the factory supplied by your transformation context instead. */ + const updateMethodSignature: (node: MethodSignature, typeParameters: NodeArray | undefined, parameters: NodeArray, type: TypeNode | undefined, name: PropertyName, questionToken: QuestionToken | undefined) => MethodSignature; + /** @deprecated Use `factory.createTypeOperatorNode` or the factory supplied by your transformation context instead. */ + const createTypeOperatorNode: { + (type: TypeNode): TypeOperatorNode; + (operator: SyntaxKind.KeyOfKeyword | SyntaxKind.UniqueKeyword | SyntaxKind.ReadonlyKeyword, type: TypeNode): TypeOperatorNode; + }; + /** @deprecated Use `factory.createTaggedTemplate` or the factory supplied by your transformation context instead. */ + const createTaggedTemplate: { + (tag: Expression, template: TemplateLiteral): TaggedTemplateExpression; + (tag: Expression, typeArguments: readonly TypeNode[] | undefined, template: TemplateLiteral): TaggedTemplateExpression; + }; + /** @deprecated Use `factory.updateTaggedTemplate` or the factory supplied by your transformation context instead. */ + const updateTaggedTemplate: { + (node: TaggedTemplateExpression, tag: Expression, template: TemplateLiteral): TaggedTemplateExpression; + (node: TaggedTemplateExpression, tag: Expression, typeArguments: readonly TypeNode[] | undefined, template: TemplateLiteral): TaggedTemplateExpression; + }; + /** @deprecated Use `factory.updateBinary` or the factory supplied by your transformation context instead. */ + const updateBinary: (node: BinaryExpression, left: Expression, right: Expression, operator?: BinaryOperator | BinaryOperatorToken) => BinaryExpression; + /** @deprecated Use `factory.createConditional` or the factory supplied by your transformation context instead. */ + const createConditional: { + (condition: Expression, whenTrue: Expression, whenFalse: Expression): ConditionalExpression; + (condition: Expression, questionToken: QuestionToken, whenTrue: Expression, colonToken: ColonToken, whenFalse: Expression): ConditionalExpression; + }; + /** @deprecated Use `factory.createYield` or the factory supplied by your transformation context instead. */ + const createYield: { + (expression?: Expression | undefined): YieldExpression; + (asteriskToken: AsteriskToken | undefined, expression: Expression): YieldExpression; + }; + /** @deprecated Use `factory.createClassExpression` or the factory supplied by your transformation context instead. */ + const createClassExpression: (modifiers: readonly Modifier[] | undefined, name: string | Identifier | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, heritageClauses: readonly HeritageClause[] | undefined, members: readonly ClassElement[]) => ClassExpression; + /** @deprecated Use `factory.updateClassExpression` or the factory supplied by your transformation context instead. */ + const updateClassExpression: (node: ClassExpression, modifiers: readonly Modifier[] | undefined, name: Identifier | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, heritageClauses: readonly HeritageClause[] | undefined, members: readonly ClassElement[]) => ClassExpression; + /** @deprecated Use `factory.createPropertySignature` or the factory supplied by your transformation context instead. */ + const createPropertySignature: (modifiers: readonly Modifier[] | undefined, name: PropertyName | string, questionToken: QuestionToken | undefined, type: TypeNode | undefined, initializer?: Expression | undefined) => PropertySignature; + /** @deprecated Use `factory.updatePropertySignature` or the factory supplied by your transformation context instead. */ + const updatePropertySignature: (node: PropertySignature, modifiers: readonly Modifier[] | undefined, name: PropertyName, questionToken: QuestionToken | undefined, type: TypeNode | undefined, initializer: Expression | undefined) => PropertySignature; + /** @deprecated Use `factory.createExpressionWithTypeArguments` or the factory supplied by your transformation context instead. */ + const createExpressionWithTypeArguments: (typeArguments: readonly TypeNode[] | undefined, expression: Expression) => ExpressionWithTypeArguments; + /** @deprecated Use `factory.updateExpressionWithTypeArguments` or the factory supplied by your transformation context instead. */ + const updateExpressionWithTypeArguments: (node: ExpressionWithTypeArguments, typeArguments: readonly TypeNode[] | undefined, expression: Expression) => ExpressionWithTypeArguments; + /** @deprecated Use `factory.createArrowFunction` or the factory supplied by your transformation context instead. */ + const createArrowFunction: { + (modifiers: readonly Modifier[] | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, equalsGreaterThanToken: EqualsGreaterThanToken | undefined, body: ConciseBody): ArrowFunction; + (modifiers: readonly Modifier[] | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, body: ConciseBody): ArrowFunction; + }; + /** @deprecated Use `factory.updateArrowFunction` or the factory supplied by your transformation context instead. */ + const updateArrowFunction: { + (node: ArrowFunction, modifiers: readonly Modifier[] | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, equalsGreaterThanToken: EqualsGreaterThanToken, body: ConciseBody): ArrowFunction; + (node: ArrowFunction, modifiers: readonly Modifier[] | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, body: ConciseBody): ArrowFunction; + }; + /** @deprecated Use `factory.createVariableDeclaration` or the factory supplied by your transformation context instead. */ + const createVariableDeclaration: { + (name: string | BindingName, type?: TypeNode | undefined, initializer?: Expression | undefined): VariableDeclaration; + (name: string | BindingName, exclamationToken: ExclamationToken | undefined, type: TypeNode | undefined, initializer: Expression | undefined): VariableDeclaration; + }; + /** @deprecated Use `factory.updateVariableDeclaration` or the factory supplied by your transformation context instead. */ + const updateVariableDeclaration: { + (node: VariableDeclaration, name: BindingName, type: TypeNode | undefined, initializer: Expression | undefined): VariableDeclaration; + (node: VariableDeclaration, name: BindingName, exclamationToken: ExclamationToken | undefined, type: TypeNode | undefined, initializer: Expression | undefined): VariableDeclaration; + }; + /** @deprecated Use `factory.createImportClause` or the factory supplied by your transformation context instead. */ + const createImportClause: (name: Identifier | undefined, namedBindings: NamedImportBindings | undefined, isTypeOnly?: any) => ImportClause; + /** @deprecated Use `factory.updateImportClause` or the factory supplied by your transformation context instead. */ + const updateImportClause: (node: ImportClause, name: Identifier | undefined, namedBindings: NamedImportBindings | undefined, isTypeOnly: boolean) => ImportClause; + /** @deprecated Use `factory.createExportDeclaration` or the factory supplied by your transformation context instead. */ + const createExportDeclaration: (decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, exportClause: NamedExportBindings | undefined, moduleSpecifier?: Expression | undefined, isTypeOnly?: any) => ExportDeclaration; + /** @deprecated Use `factory.updateExportDeclaration` or the factory supplied by your transformation context instead. */ + const updateExportDeclaration: (node: ExportDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, exportClause: NamedExportBindings | undefined, moduleSpecifier: Expression | undefined, isTypeOnly: boolean) => ExportDeclaration; + /** @deprecated Use `factory.createJSDocParameterTag` or the factory supplied by your transformation context instead. */ + const createJSDocParamTag: (name: EntityName, isBracketed: boolean, typeExpression?: JSDocTypeExpression | undefined, comment?: string | undefined) => JSDocParameterTag; + /** @deprecated Use `factory.createComma` or the factory supplied by your transformation context instead. */ + const createComma: (left: Expression, right: Expression) => Expression; + /** @deprecated Use `factory.createLessThan` or the factory supplied by your transformation context instead. */ + const createLessThan: (left: Expression, right: Expression) => Expression; + /** @deprecated Use `factory.createAssignment` or the factory supplied by your transformation context instead. */ + const createAssignment: (left: Expression, right: Expression) => BinaryExpression; + /** @deprecated Use `factory.createStrictEquality` or the factory supplied by your transformation context instead. */ + const createStrictEquality: (left: Expression, right: Expression) => BinaryExpression; + /** @deprecated Use `factory.createStrictInequality` or the factory supplied by your transformation context instead. */ + const createStrictInequality: (left: Expression, right: Expression) => BinaryExpression; + /** @deprecated Use `factory.createAdd` or the factory supplied by your transformation context instead. */ + const createAdd: (left: Expression, right: Expression) => BinaryExpression; + /** @deprecated Use `factory.createSubtract` or the factory supplied by your transformation context instead. */ + const createSubtract: (left: Expression, right: Expression) => BinaryExpression; + /** @deprecated Use `factory.createLogicalAnd` or the factory supplied by your transformation context instead. */ + const createLogicalAnd: (left: Expression, right: Expression) => BinaryExpression; + /** @deprecated Use `factory.createLogicalOr` or the factory supplied by your transformation context instead. */ + const createLogicalOr: (left: Expression, right: Expression) => BinaryExpression; + /** @deprecated Use `factory.createPostfixIncrement` or the factory supplied by your transformation context instead. */ + const createPostfixIncrement: (operand: Expression) => PostfixUnaryExpression; + /** @deprecated Use `factory.createLogicalNot` or the factory supplied by your transformation context instead. */ + const createLogicalNot: (operand: Expression) => PrefixUnaryExpression; + /** @deprecated Use an appropriate `factory` method instead. */ + const createNode: (kind: SyntaxKind, pos?: any, end?: any) => Node; + /** + * Creates a shallow, memberwise clone of a node ~for mutation~ with its `pos`, `end`, and `parent` set. + * + * NOTE: It is unsafe to change any properties of a `Node` that relate to its AST children, as those changes won't be + * captured with respect to transformations. + * + * @deprecated Use `factory.cloneNode` instead and use `setCommentRange` or `setSourceMapRange` and avoid setting `parent`. + */ + const getMutableClone: (node: T) => T; + /** @deprecated Use `isTypeAssertionExpression` instead. */ + const isTypeAssertion: (node: Node) => node is TypeAssertion; + /** + * @deprecated Use `ts.ReadonlyESMap` instead. + */ + interface ReadonlyMap extends ReadonlyESMap { + } + /** + * @deprecated Use `ts.ESMap` instead. + */ + interface Map extends ESMap { + } +} + +export = ts; \ No newline at end of file diff --git a/packages/common/package.json b/packages/common/package.json index eca610224..5d403f8fe 100644 --- a/packages/common/package.json +++ b/packages/common/package.json @@ -14,15 +14,14 @@ "test": "cross-env TS_NODE_COMPILER=\"ttypescript\" TS_NODE_TRANSPILE_ONLY=\"true\" mocha", "test:ci": "yarn test", "test:debug": "yarn test --inspect-brk", - "rollup": "rollup --config" + "rollup": "rollup --config && ts-node scripts/bundleLocalTs.ts" }, "dependencies": { "@dsherret/to-absolute-glob": "^2.0.2", "fast-glob": "^3.2.5", "is-negated-glob": "^1.0.0", "mkdirp": "^1.0.4", - "multimatch": "^5.0.0", - "typescript": "~4.1.3" + "multimatch": "^5.0.0" }, "devDependencies": { "@ts-morph/scripts": "~0.2.0", @@ -43,7 +42,8 @@ "ts-morph": "npm:ts-morph@9.0.0", "ts-nameof": "^5.0.0", "ts-node": "^9.1.1", - "ttypescript": "^1.5.12" + "ttypescript": "^1.5.12", + "typescript": "~4.1.3" }, "publishConfig": { "access": "public" diff --git a/packages/common/scripts/buildDeclarations.ts b/packages/common/scripts/buildDeclarations.ts index 647fd1203..145b89413 100644 --- a/packages/common/scripts/buildDeclarations.ts +++ b/packages/common/scripts/buildDeclarations.ts @@ -13,7 +13,7 @@ const writeProject = new tsMorph.Project({ const declarationFile = writeProject.addSourceFileAtPath("lib/ts-morph-common.d.ts"); const writer = declarationProject.createWriter(); -writer.write(`import * as ts from `).quote("typescript").write(";").newLine(); +writer.write(`import * as ts from `).quote("./typescript").write(";").newLine(); const tsNames: string[] = []; @@ -37,7 +37,7 @@ for (const [name, declarations] of emitMainFile.getExportedDeclarations()) { } writer.blankLineIfLastNot(); -writer.writeLine(`import { ${tsNames.join(", ")} } from "typescript";`); +writer.writeLine(`import { ${tsNames.join(", ")} } from "./typescript";`); writer.writeLine(`export { ts, ${tsNames.join(", ")} };`); // todo: format using dprint diff --git a/packages/common/scripts/bundleLocalTs.ts b/packages/common/scripts/bundleLocalTs.ts new file mode 100644 index 000000000..ba4ffdc49 --- /dev/null +++ b/packages/common/scripts/bundleLocalTs.ts @@ -0,0 +1,20 @@ +import { Node, Project } from "ts-morph"; + +const project = new Project(); + +const commonFile = project.addSourceFileAtPath("./dist/ts-morph-common.js"); + +for (const varDecl of commonFile.getVariableDeclarations()) { + const initializer = varDecl.getInitializer(); + if (initializer != null && Node.isCallExpression(initializer) && initializer.getExpression().getText() === "require") { + const args = initializer.getArguments(); + const firstArg = args?.[0]; + if (args.length === 1 && firstArg != null && Node.isStringLiteral(firstArg) && firstArg.getLiteralValue() === "typescript") + varDecl.setInitializer("require('./typescript')"); + } +} + +commonFile.saveSync(); + +project.getFileSystem().copySync("node_modules/typescript/lib/typescript.js", "./dist/typescript.js"); +project.getFileSystem().copySync("node_modules/typescript/lib/typescript.d.ts", "./lib/typescript.d.ts"); diff --git a/packages/common/src/compiler/DocumentRegistry.ts b/packages/common/src/compiler/DocumentRegistry.ts index 043a93cd7..ab1cc901b 100644 --- a/packages/common/src/compiler/DocumentRegistry.ts +++ b/packages/common/src/compiler/DocumentRegistry.ts @@ -116,7 +116,7 @@ export class DocumentRegistry implements ts.DocumentRegistry { } /** @inheritdoc */ - getSourceFileVersion(sourceFile: ts.SourceFile) { + getSourceFileVersion(sourceFile: ts.SourceFile): string { return (sourceFile as any).version || "0"; } diff --git a/packages/common/src/compiler/TsSourceFileContainer.ts b/packages/common/src/compiler/TsSourceFileContainer.ts index 3a1592bba..afccacf42 100644 --- a/packages/common/src/compiler/TsSourceFileContainer.ts +++ b/packages/common/src/compiler/TsSourceFileContainer.ts @@ -37,6 +37,16 @@ export interface TsSourceFileContainer { markInProject: boolean; scriptKind: ScriptKind | undefined; }): ts.SourceFile | undefined; + /** + * Adds a lib file whose existence is virtual to the cache. + * @param filePath - File path to get. + * @param scriptKind - Script kind of the source file. + */ + addLibFileToCacheByText( + filePath: StandardizedFilePath, + fileText: string, + scriptKind: ScriptKind | undefined, + ): ts.SourceFile; /** * Gets the source file version of the specified source file. * @param sourceFile - Source file to inspect. diff --git a/packages/common/src/compiler/createHosts.ts b/packages/common/src/compiler/createHosts.ts index f43afd854..1f1f9a806 100644 --- a/packages/common/src/compiler/createHosts.ts +++ b/packages/common/src/compiler/createHosts.ts @@ -1,6 +1,8 @@ -import { FileUtils, RealFileSystemHost, StandardizedFilePath, TransactionalFileSystem } from "../fileSystem"; +import { errors } from "../errors"; +import { StandardizedFilePath, TransactionalFileSystem } from "../fileSystem"; +import { getLibFiles, libFolderInMemoryPath } from "../getLibFiles"; import { CompilerOptionsContainer } from "../options"; -import { CompilerOptions, ScriptTarget, ts } from "../typescript"; +import { ScriptTarget, ts } from "../typescript"; import { ResolutionHost } from "./ResolutionHost"; import { TsSourceFileContainer } from "./TsSourceFileContainer"; @@ -22,6 +24,16 @@ export interface CreateHostsOptions { * changed. Provide this for a performance improvement. */ getProjectVersion?: () => string; isKnownTypesPackageName?: ts.LanguageServiceHost["isKnownTypesPackageName"]; + /** + * Set this to true to not load the typescript lib files. + * @default false + */ + skipLoadingLibFiles?: boolean; + /** + * Specify this to use a custom folder to load the lib files from. + * @remarks skipLoadingLibFiles cannot be explicitly false if this is set. + */ + libFolderPath?: string; } /** @@ -31,6 +43,9 @@ export interface CreateHostsOptions { export function createHosts(options: CreateHostsOptions) { const { transactionalFileSystem, sourceFileContainer, compilerOptions, getNewLine, resolutionHost, getProjectVersion, isKnownTypesPackageName } = options; let version = 0; + const libFolderPath = transactionalFileSystem.getStandardizedAbsolutePath(getLibFolderPath()); + const libFileMap = getLibFileMap(); + const fileExistsSync = (path: StandardizedFilePath) => sourceFileContainer.containsSourceFileAtPath(path) || transactionalFileSystem.fileExistsSync(path); @@ -48,8 +63,15 @@ export function createHosts(options: CreateHostsOptions) { }, getScriptSnapshot: fileName => { const filePath = transactionalFileSystem.getStandardizedAbsolutePath(fileName); - if (!fileExistsSync(filePath)) + if (!fileExistsSync(filePath)) { + if (libFileMap != null) { + const libFileText = libFileMap.get(filePath); + if (libFileText != null) + return ts.ScriptSnapshot.fromString(libFileText); + } + return undefined; + } return ts.ScriptSnapshot.fromString(sourceFileContainer.addOrGetSourceFileFromFilePathSync(filePath, { markInProject: false, scriptKind: undefined, @@ -57,24 +79,25 @@ export function createHosts(options: CreateHostsOptions) { }, getCurrentDirectory: () => transactionalFileSystem.getCurrentDirectory(), getDefaultLibFileName: options => { - if (transactionalFileSystem.getFileSystem() instanceof RealFileSystemHost) - return ts.getDefaultLibFilePath(options); - else { - return FileUtils.pathJoin( - transactionalFileSystem.getCurrentDirectory(), - "node_modules/typescript/lib/" + ts.getDefaultLibFileName(options), - ); - } + return libFolderPath + "/" + ts.getDefaultLibFileName(options); }, isKnownTypesPackageName, useCaseSensitiveFileNames: () => true, readFile: (path, encoding) => { const standardizedPath = transactionalFileSystem.getStandardizedAbsolutePath(path); + if (libFileMap != null) { + const libFileText = libFileMap.get(standardizedPath); + if (libFileText != null) + return libFileText; + } if (sourceFileContainer.containsSourceFileAtPath(standardizedPath)) return sourceFileContainer.getSourceFileFromCacheFromFilePath(standardizedPath)!.getFullText(); return transactionalFileSystem.readFileSync(standardizedPath, encoding); }, - fileExists: fileExistsSync, + fileExists: filePath => { + const standardizedFilePath = transactionalFileSystem.getStandardizedAbsolutePath(filePath); + return fileExistsSync(standardizedFilePath) || libFileMap != null && libFileMap.has(standardizedFilePath); + }, directoryExists: dirName => { const dirPath = transactionalFileSystem.getStandardizedAbsolutePath(dirName); return sourceFileContainer.containsDirectoryAtPath(dirPath) @@ -88,8 +111,23 @@ export function createHosts(options: CreateHostsOptions) { const compilerHost: ts.CompilerHost = { getSourceFile: (fileName: string, languageVersion: ScriptTarget, onError?: (message: string) => void) => { - // todo: use languageVersion here? const filePath = transactionalFileSystem.getStandardizedAbsolutePath(fileName); + if (libFileMap != null) { + const libFileText = libFileMap.get(filePath); + if (libFileText != null) { + let sourceFile = sourceFileContainer.getSourceFileFromCacheFromFilePath(filePath); + if (sourceFile == null) { + sourceFile = sourceFileContainer.addLibFileToCacheByText( + filePath, + libFileText, + ts.ScriptKind.TS, + ); + } + return sourceFile; + } + } + + // todo: use languageVersion here? But how? return sourceFileContainer.addOrGetSourceFileFromFilePathSync(filePath, { markInProject: false, scriptKind: undefined, @@ -117,4 +155,32 @@ export function createHosts(options: CreateHostsOptions) { }; return { languageServiceHost, compilerHost }; + + function getLibFolderPath() { + if (options.libFolderPath != null) { + if (options.skipLoadingLibFiles === true) { + throw new errors.InvalidOperationError( + `Cannot set ${nameof(options.skipLoadingLibFiles)} to true when ${nameof(options.libFolderPath)} is provided.`, + ); + } + return options.libFolderPath; + } + return libFolderInMemoryPath; + } + + function getLibFileMap() { + if (options.skipLoadingLibFiles || options.libFolderPath != null) + return undefined; + + const libFilesMap = new Map(); + const libFiles = getLibFiles(); + for (const libFile of libFiles) { + libFilesMap.set( + transactionalFileSystem.getStandardizedAbsolutePath(libFolderPath + "/" + libFile.fileName), + libFile.text, + ); + } + + return libFilesMap; + } } diff --git a/packages/common/src/fileSystem/InMemoryFileSystemHost.ts b/packages/common/src/fileSystem/InMemoryFileSystemHost.ts index f725696e3..2b14b6b44 100644 --- a/packages/common/src/fileSystem/InMemoryFileSystemHost.ts +++ b/packages/common/src/fileSystem/InMemoryFileSystemHost.ts @@ -1,5 +1,4 @@ import { errors } from "../errors"; -import { getLibFiles } from "../getLibFiles"; import { FileSystemHost } from "./FileSystemHost"; import { FileUtils } from "./FileUtils"; import { matchGlobs } from "./matchGlobs"; @@ -10,14 +9,6 @@ interface VirtualDirectory { files: Map; } -export interface InMemoryFileSystemHostOptions { - /** - * Set this to true to not load the /node_modules/typescript/lib files on construction. - * @default false - */ - skipLoadingLibFiles?: boolean; -} - /** An implementation of a file system that exists in memory only. */ export class InMemoryFileSystemHost implements FileSystemHost { /** @internal */ @@ -25,16 +16,9 @@ export class InMemoryFileSystemHost implements FileSystemHost { /** * Constructor. - * @param options - Options for creating the file system. */ - constructor(options?: InMemoryFileSystemHostOptions) { + constructor() { this.getOrCreateDir("/" as StandardizedFilePath); - - if (!options?.skipLoadingLibFiles) { - const libFiles = getLibFiles(); - for (const libFile of libFiles) - this._writeFileSync(`/node_modules/typescript/lib/${libFile.fileName}`, libFile.text); - } } /** @inheritdoc */ diff --git a/packages/common/src/getLibFiles.ts b/packages/common/src/getLibFiles.ts index 7ddb867ee..93e774eac 100644 --- a/packages/common/src/getLibFiles.ts +++ b/packages/common/src/getLibFiles.ts @@ -1,5 +1,10 @@ +import { StandardizedFilePath } from "./fileSystem"; + /** Loads the lib files that are stored in a separate module. */ export function getLibFiles() { const libFiles: typeof import("./data/libFiles") = require("./data/libFiles"); return libFiles.libFiles; } + +/** The folder to use to "store" the lib files. @internal */ +export const libFolderInMemoryPath = "/node_modules/typescript/lib" as StandardizedFilePath; diff --git a/packages/common/src/tests/fileSystem/inMemoryFileSystemHostTests.ts b/packages/common/src/tests/fileSystem/inMemoryFileSystemHostTests.ts index 8bc86193d..8092f297b 100644 --- a/packages/common/src/tests/fileSystem/inMemoryFileSystemHostTests.ts +++ b/packages/common/src/tests/fileSystem/inMemoryFileSystemHostTests.ts @@ -1,24 +1,12 @@ import { expect } from "chai"; import { errors } from "../../errors"; import { InMemoryFileSystemHost } from "../../fileSystem"; -import { getLibFiles } from "../../getLibFiles"; describe(nameof(InMemoryFileSystemHost), () => { describe("constructor", () => { it("should have the main directory after being constructed", () => { - expect(new InMemoryFileSystemHost().directoryExistsSync("/")).to.be.true; - }); - - it("should load the lib files by default", () => { const fileSystem = new InMemoryFileSystemHost(); - expect(fileSystem.readDirSync("/")).to.deep.equal(["/node_modules"]); - expect(fileSystem.readDirSync("/node_modules/typescript/lib")).to.deep.equal(getLibFiles().map(file => { - return `/node_modules/typescript/lib/${file.fileName}`; - })); - }); - - it("should not load the lib files when specifying not to", () => { - const fileSystem = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }); + expect(fileSystem.directoryExistsSync("/")).to.be.true; expect(fileSystem.readDirSync("/")).to.deep.equal([]); }); }); diff --git a/packages/common/src/tests/fileSystem/transactionalFileSystemTests.ts b/packages/common/src/tests/fileSystem/transactionalFileSystemTests.ts index 01615a688..434e199a4 100644 --- a/packages/common/src/tests/fileSystem/transactionalFileSystemTests.ts +++ b/packages/common/src/tests/fileSystem/transactionalFileSystemTests.ts @@ -9,7 +9,7 @@ describe(nameof(TransactionalFileSystem), () => { } function setup(): SetupObjects { - const fileSystem = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }); + const fileSystem = new InMemoryFileSystemHost(); return { fileSystem, wrapper: new TransactionalFileSystem(fileSystem) }; } diff --git a/packages/ts-morph/lib/ts-morph.d.ts b/packages/ts-morph/lib/ts-morph.d.ts index 577120524..cc2b2db09 100644 --- a/packages/ts-morph/lib/ts-morph.d.ts +++ b/packages/ts-morph/lib/ts-morph.d.ts @@ -67,11 +67,8 @@ export interface FileSystemHost { /** An implementation of a file system that exists in memory only. */ export declare class InMemoryFileSystemHost implements FileSystemHost { - /** - * Constructor. - * @param options - Options for creating the file system. - */ - constructor(options?: InMemoryFileSystemHostOptions); + /** Constructor. */ + constructor(); /** @inheritdoc */ isCaseSensitive(): boolean; /** @inheritdoc */ @@ -118,14 +115,6 @@ export declare class InMemoryFileSystemHost implements FileSystemHost { globSync(patterns: ReadonlyArray): string[]; } -export interface InMemoryFileSystemHostOptions { - /** - * Set this to true to not load the /node_modules/typescript/lib files on construction. - * @default false - */ - skipLoadingLibFiles?: boolean; -} - /** Host for implementing custom module and/or type reference directive resolution. */ export interface ResolutionHost { resolveModuleNames?: ts.LanguageServiceHost["resolveModuleNames"]; @@ -717,8 +706,16 @@ export interface ProjectOptions { skipAddingFilesFromTsConfig?: boolean; /** Skip resolving file dependencies when providing a ts config file path and adding the files from tsconfig. @default false */ skipFileDependencyResolution?: boolean; - /** Skip loading the lib files when using an in-memory file system. @default false */ + /** + * Skip loading the lib files. Unlike the compiler API, ts-morph does not load these + * from the node_modules folder, but instead loads them from some other JS code + * and uses a fake path for their existence. If you want to use a custom lib files + * folder path, then provide one using the libFolderPath options. + * @default false + */ skipLoadingLibFiles?: boolean; + /** The folder to use for loading lib files. */ + libFolderPath?: string; /** Manipulation settings */ manipulationSettings?: Partial; /** Whether to use an in-memory file system. @default false */ @@ -1603,7 +1600,7 @@ export interface ReferenceFindableNode { } declare type ReferenceFindableNodeExtensionType = Node; export declare function RenameableNode>(Base: T): Constructor & T; @@ -3080,6 +3077,8 @@ export declare class Node { static readonly isMethodSignature: (node: Node | undefined) => node is MethodSignature; /** Gets if the node is a ModuleBlock. */ static readonly isModuleBlock: (node: Node | undefined) => node is ModuleBlock; + /** Gets if the node is a ModuleDeclaration. */ + static readonly isModuleDeclaration: (node: Node | undefined) => node is ModuleDeclaration; /** Gets if the node is a NamedExports. */ static readonly isNamedExports: (node: Node | undefined) => node is NamedExports; /** Gets if the node is a NamedImports. */ @@ -4083,30 +4082,30 @@ export declare class Node { */ static isModifierableNode(node: T | undefined): node is ModifierableNode & ModifierableNodeExtensionType & T; /** - * Gets if the node is a ModuledNode. + * Gets if the node is a ModuleChildableNode. * @param node - Node to check. */ - static isModuledNode(node: T | undefined): node is ModuledNode & ModuledNodeExtensionType & T; + static isModuleChildableNode(node: T | undefined): node is ModuleChildableNode & ModuleChildableNodeExtensionType & T; /** - * Gets if the node is a NameableNode. + * Gets if the node is a ModuleNamedNode. * @param node - Node to check. */ - static isNameableNode(node: T | undefined): node is NameableNode & NameableNodeExtensionType & T; + static isModuleNamedNode(node: T | undefined): node is ModuleNamedNode & ModuleNamedNodeExtensionType & T; /** - * Gets if the node is a NamedNode. + * Gets if the node is a ModuledNode. * @param node - Node to check. */ - static isNamedNode(node: T | undefined): node is NamedNode & NamedNodeExtensionType & T; + static isModuledNode(node: T | undefined): node is ModuledNode & ModuledNodeExtensionType & T; /** - * Gets if the node is a NamespaceChildableNode. + * Gets if the node is a NameableNode. * @param node - Node to check. */ - static isNamespaceChildableNode(node: T | undefined): node is ModuleChildableNode & NamespaceChildableNodeExtensionType & T; + static isNameableNode(node: T | undefined): node is NameableNode & NameableNodeExtensionType & T; /** - * Gets if the node is a ModuleDeclaration. + * Gets if the node is a NamedNode. * @param node - Node to check. */ - static isModuleDeclaration(node: Node | undefined): node is ModuleDeclaration; + static isNamedNode(node: T | undefined): node is NamedNode & NamedNodeExtensionType & T; /** * Gets if the node is a NullLiteral. * @param node - Node to check. @@ -7047,7 +7046,7 @@ export declare class ModuleBlock extends ModuleBlockBase { getParentOrThrow(): NonNullable>; } -export declare function ModuleChildableNode>(Base: T): Constructor & T; +export declare function ModuleChildableNode>(Base: T): Constructor & T; export interface ModuleChildableNode { /** Gets the parent module declaration or undefined if it doesn't exist. */ @@ -7056,7 +7055,7 @@ export interface ModuleChildableNode { getParentModuleOrThrow(): ModuleDeclaration; } -declare type NamespaceChildableNodeExtensionType = Node; +declare type ModuleChildableNodeExtensionType = Node; declare const ModuleDeclarationBase: Constructor & Constructor & Constructor & Constructor & Constructor & Constructor & Constructor & Constructor & Constructor & Constructor & Constructor & typeof Statement; export declare class ModuleDeclaration extends ModuleDeclarationBase { @@ -9822,6 +9821,10 @@ export interface BindingNamedNodeStructure { name: string; } +export interface ModuleNamedNodeStructure { + name: string; +} + export interface NameableNodeStructure { name?: string; } @@ -10175,7 +10178,7 @@ interface ImportSpecifierSpecificStructure extends KindedStructure { @@ -10476,7 +10479,7 @@ export declare const Structure: { kind: StructureKind; }) => structure is ImportSpecifierStructure; /** Gets if the provided structure is a ModuleDeclarationStructure. */ - readonly isNamespace: (structure: Structure & { + readonly isModule: (structure: Structure & { kind: StructureKind; }) => structure is ModuleDeclarationStructure; /** Gets if the provided structure is a SourceFileStructure. */ diff --git a/packages/ts-morph/scripts/config/isAllowedMixin.ts b/packages/ts-morph/scripts/config/isAllowedMixin.ts index c639ecd6c..ec70798e6 100644 --- a/packages/ts-morph/scripts/config/isAllowedMixin.ts +++ b/packages/ts-morph/scripts/config/isAllowedMixin.ts @@ -5,7 +5,7 @@ export function isAllowedMixin(name: string) { case "PropertyNamedNode": case "BindingNamedNode": case "HeritageClauseableNode": - case "NamespaceChildableNode": + case "ModuleChildableNode": case "OverloadableNode": case "TextInsertableNode": case "UnwrappableNode": diff --git a/packages/ts-morph/scripts/generation/declarationFile/getDeclarationFileStatements.ts b/packages/ts-morph/scripts/generation/declarationFile/getDeclarationFileStatements.ts index 02c9015c2..88212d3f5 100644 --- a/packages/ts-morph/scripts/generation/declarationFile/getDeclarationFileStatements.ts +++ b/packages/ts-morph/scripts/generation/declarationFile/getDeclarationFileStatements.ts @@ -12,11 +12,14 @@ export function getDeclarationFileStatements(mainFile: tsMorph.SourceFile) { }); for (const [name, declarations] of mainFile.getExportedDeclarations()) { + if (name === "ts") + continue; + for (const declaration of declarations) { const sourceFile = declaration.getSourceFile(); if (sourceFile.isInNodeModules()) { const filePath = sourceFile.getFilePath(); - if (filePath.includes("node_modules/typescript/")) { + if (filePath.includes("/typescript.d.ts")) { if (name !== "ts") tsNames.push(name); continue; diff --git a/packages/ts-morph/src/Project.ts b/packages/ts-morph/src/Project.ts index 3ea967a2a..1bd7899b4 100644 --- a/packages/ts-morph/src/Project.ts +++ b/packages/ts-morph/src/Project.ts @@ -18,8 +18,16 @@ export interface ProjectOptions { skipAddingFilesFromTsConfig?: boolean; /** Skip resolving file dependencies when providing a ts config file path and adding the files from tsconfig. @default false */ skipFileDependencyResolution?: boolean; - /** Skip loading the lib files when using an in-memory file system. @default false */ + /** + * Skip loading the lib files. Unlike the compiler API, ts-morph does not load these + * from the node_modules folder, but instead loads them from some other JS code + * and uses a fake path for their existence. If you want to use a custom lib files + * folder path, then provide one using the libFolderPath options. + * @default false + */ skipLoadingLibFiles?: boolean; + /** The folder to use for loading lib files. */ + libFolderPath?: string; /** Manipulation settings */ manipulationSettings?: Partial; /** Whether to use an in-memory file system. @default false */ @@ -82,6 +90,8 @@ export class Project { createLanguageService: true, resolutionHost: options.resolutionHost, configFileParsingDiagnostics: tsConfigResolver?.getErrors() ?? [], + skipLoadingLibFiles: options.skipLoadingLibFiles, + libFolderPath: options.libFolderPath, }); // initialize manipulation settings @@ -99,16 +109,11 @@ export class Project { function verifyOptions() { if (options.fileSystem != null && options.useInMemoryFileSystem) throw new errors.InvalidOperationError("Cannot provide a file system when specifying to use an in-memory file system."); - if (options.skipLoadingLibFiles && !options.useInMemoryFileSystem) { - throw new errors.InvalidOperationError( - `The ${nameof(options.skipLoadingLibFiles)} option can only be true when ${nameof(options.useInMemoryFileSystem)} is true.`, - ); - } } function getFileSystem() { if (options.useInMemoryFileSystem) - return new InMemoryFileSystemHost({ skipLoadingLibFiles: options.skipLoadingLibFiles }); + return new InMemoryFileSystemHost(); return options.fileSystem ?? new RealFileSystemHost(); } diff --git a/packages/ts-morph/src/ProjectContext.ts b/packages/ts-morph/src/ProjectContext.ts index 8d5b266dc..1c75a46dd 100644 --- a/packages/ts-morph/src/ProjectContext.ts +++ b/packages/ts-morph/src/ProjectContext.ts @@ -10,7 +10,7 @@ import { ConsoleLogger, LazyReferenceCoordinator } from "./utils"; import { createWrappedNode } from "./utils/compiler/createWrappedNode"; /** @internal */ -export interface ProjectContextCreationData { +export interface ProjectContextCreationParams { project: Project | undefined; fileSystemWrapper: TransactionalFileSystem; compilerOptionsContainer: CompilerOptionsContainer; @@ -18,6 +18,8 @@ export interface ProjectContextCreationData { createLanguageService: boolean; resolutionHost?: ResolutionHostFactory; typeChecker?: ts.TypeChecker; + skipLoadingLibFiles: boolean | undefined; + libFolderPath: string | undefined; } /** @@ -45,27 +47,29 @@ export class ProjectContext { readonly compilerFactory: CompilerFactory; readonly inProjectCoordinator: InProjectCoordinator; - constructor(opts: ProjectContextCreationData) { - this._project = opts.project; - this.fileSystemWrapper = opts.fileSystemWrapper; - this._compilerOptions = opts.compilerOptionsContainer; + constructor(params: ProjectContextCreationParams) { + this._project = params.project; + this.fileSystemWrapper = params.fileSystemWrapper; + this._compilerOptions = params.compilerOptionsContainer; this.compilerFactory = new CompilerFactory(this); this.inProjectCoordinator = new InProjectCoordinator(this.compilerFactory); this.structurePrinterFactory = new StructurePrinterFactory(() => this.manipulationSettings.getFormatCodeSettings()); this.lazyReferenceCoordinator = new LazyReferenceCoordinator(this.compilerFactory); - this.directoryCoordinator = new DirectoryCoordinator(this.compilerFactory, opts.fileSystemWrapper); - this._languageService = opts.createLanguageService + this.directoryCoordinator = new DirectoryCoordinator(this.compilerFactory, params.fileSystemWrapper); + this._languageService = params.createLanguageService ? new LanguageService({ context: this, - configFileParsingDiagnostics: opts.configFileParsingDiagnostics, - resolutionHost: opts.resolutionHost && opts.resolutionHost(this.getModuleResolutionHost(), () => this.compilerOptions.get()), + configFileParsingDiagnostics: params.configFileParsingDiagnostics, + resolutionHost: params.resolutionHost && params.resolutionHost(this.getModuleResolutionHost(), () => this.compilerOptions.get()), + skipLoadingLibFiles: params.skipLoadingLibFiles, + libFolderPath: params.libFolderPath, }) : undefined; - if (opts.typeChecker != null) { - errors.throwIfTrue(opts.createLanguageService, "Cannot specify a type checker and create a language service."); + if (params.typeChecker != null) { + errors.throwIfTrue(params.createLanguageService, "Cannot specify a type checker and create a language service."); this._customTypeChecker = new TypeChecker(this); - this._customTypeChecker._reset(() => opts.typeChecker!); + this._customTypeChecker._reset(() => params.typeChecker!); } } @@ -173,6 +177,14 @@ export class ProjectContext { addOrGetSourceFileFromFilePathSync: (filePath, opts) => { return this.compilerFactory.addOrGetSourceFileFromFilePath(filePath, opts)?.compilerNode; }, + addLibFileToCacheByText: (filePath, fileText, scriptKind) => { + return this.compilerFactory.documentRegistry.createOrUpdateSourceFile( + filePath, + this.compilerOptions.get(), + ts.ScriptSnapshot.fromString(fileText), + scriptKind, + ); + }, containsDirectoryAtPath: dirPath => this.compilerFactory.containsDirectoryAtPath(dirPath), containsSourceFileAtPath: filePath => this.compilerFactory.containsSourceFileAtPath(filePath), getSourceFileFromCacheFromFilePath: filePath => { diff --git a/packages/ts-morph/src/compiler/ast/module/ImportSpecifier.ts b/packages/ts-morph/src/compiler/ast/module/ImportSpecifier.ts index 8ae9b3b21..ef6b43cd1 100644 --- a/packages/ts-morph/src/compiler/ast/module/ImportSpecifier.ts +++ b/packages/ts-morph/src/compiler/ast/module/ImportSpecifier.ts @@ -34,7 +34,7 @@ export class ImportSpecifier extends ImportSpecifierBase { * Gets the name node of what's being imported. */ getNameNode() { - return this._getNodeFromCompilerNode(this.compilerNode.propertyName || this.compilerNode.name); + return this._getNodeFromCompilerNode(this.compilerNode.propertyName ?? this.compilerNode.name); } /** diff --git a/packages/ts-morph/src/compiler/tools/LanguageService.ts b/packages/ts-morph/src/compiler/tools/LanguageService.ts index 787c17366..2463b92c6 100644 --- a/packages/ts-morph/src/compiler/tools/LanguageService.ts +++ b/packages/ts-morph/src/compiler/tools/LanguageService.ts @@ -1,5 +1,4 @@ -import { CompilerOptions, createHosts, EditorSettings, errors, FileUtils, ObjectUtils, RealFileSystemHost, ResolutionHost, ScriptTarget, ts, - TsSourceFileContainer } from "@ts-morph/common"; +import { createHosts, EditorSettings, errors, ObjectUtils, ResolutionHost, ts } from "@ts-morph/common"; import { getTextFromTextChanges } from "../../manipulation"; import { ProjectContext } from "../../ProjectContext"; import { fillDefaultEditorSettings, fillDefaultFormatCodeSettings } from "../../utils"; @@ -11,10 +10,12 @@ import { CodeFixAction, CombinedCodeActions, DefinitionInfo, DiagnosticWithLocat RenameLocation, TextChange } from "./results"; /** @internal */ -export interface LanguageServiceCreationData { +export interface LanguageServiceCreationParams { context: ProjectContext; configFileParsingDiagnostics: ts.Diagnostic[]; resolutionHost?: ResolutionHost; + skipLoadingLibFiles: boolean | undefined; + libFolderPath: string | undefined; } export class LanguageService { @@ -37,8 +38,8 @@ export class LanguageService { } /** @private */ - constructor(opts: LanguageServiceCreationData) { - this._context = opts.context; + constructor(params: LanguageServiceCreationParams) { + this._context = params.context; const { languageServiceHost, compilerHost } = createHosts({ transactionalFileSystem: this._context.fileSystemWrapper, @@ -46,7 +47,9 @@ export class LanguageService { compilerOptions: this._context.compilerOptions, getNewLine: () => this._context.manipulationSettings.getNewLineKindAsString(), getProjectVersion: () => `${this._projectVersion}`, - resolutionHost: opts.resolutionHost ?? {}, + resolutionHost: params.resolutionHost ?? {}, + libFolderPath: params.libFolderPath, + skipLoadingLibFiles: params.skipLoadingLibFiles, }); this._compilerHost = compilerHost; @@ -55,7 +58,7 @@ export class LanguageService { context: this._context, rootNames: Array.from(this._context.compilerFactory.getSourceFilePaths()), host: this._compilerHost, - configFileParsingDiagnostics: opts.configFileParsingDiagnostics, + configFileParsingDiagnostics: params.configFileParsingDiagnostics, }); this._context.compilerFactory.onSourceFileAdded(() => this._reset()); diff --git a/packages/ts-morph/src/main.ts b/packages/ts-morph/src/main.ts index 83aa5430a..a5c8135b2 100644 --- a/packages/ts-morph/src/main.ts +++ b/packages/ts-morph/src/main.ts @@ -1,8 +1,8 @@ /// import { errors } from "@ts-morph/common"; -export { CompilerOptions, CompilerOptionsContainer, DiagnosticCategory, EditorSettings, EmitHint, FileSystemHost, InMemoryFileSystemHost, - InMemoryFileSystemHostOptions, LanguageVariant, ModuleKind, ModuleResolutionKind, NewLineKind, NodeFlags, ObjectFlags, ResolutionHost, - ResolutionHostFactory, ScriptKind, ScriptTarget, SettingsContainer, SymbolFlags, SyntaxKind, ts, TypeFlags, TypeFormatFlags } from "@ts-morph/common"; +export { CompilerOptions, CompilerOptionsContainer, DiagnosticCategory, EditorSettings, EmitHint, FileSystemHost, InMemoryFileSystemHost, LanguageVariant, + ModuleKind, ModuleResolutionKind, NewLineKind, NodeFlags, ObjectFlags, ResolutionHost, ResolutionHostFactory, ScriptKind, ScriptTarget, SettingsContainer, + SymbolFlags, SyntaxKind, ts, TypeFlags, TypeFormatFlags } from "@ts-morph/common"; export * from "./codeBlockWriter"; export * from "./compiler"; const { InvalidOperationError, FileNotFoundError, ArgumentError, ArgumentNullOrWhitespaceError, ArgumentOutOfRangeError, ArgumentTypeError, BaseError, diff --git a/packages/ts-morph/src/structures/base/name/ModuleNamedNodeStructure.ts b/packages/ts-morph/src/structures/base/name/ModuleNamedNodeStructure.ts new file mode 100644 index 000000000..14730d7a8 --- /dev/null +++ b/packages/ts-morph/src/structures/base/name/ModuleNamedNodeStructure.ts @@ -0,0 +1,3 @@ +export interface ModuleNamedNodeStructure { + name: string; +} diff --git a/packages/ts-morph/src/structures/base/name/index.ts b/packages/ts-morph/src/structures/base/name/index.ts index a8b92746f..21f95616c 100644 --- a/packages/ts-morph/src/structures/base/name/index.ts +++ b/packages/ts-morph/src/structures/base/name/index.ts @@ -1,4 +1,5 @@ export * from "./BindingNamedNodeStructure"; +export * from "./ModuleNamedNodeStructure"; export * from "./NameableNodeStructure"; export * from "./NamedNodeStructure"; export * from "./PropertyNameableNodeStructure"; diff --git a/packages/ts-morph/src/structures/module/ModuleDeclarationStructure.ts b/packages/ts-morph/src/structures/module/ModuleDeclarationStructure.ts index 156a9c4db..adb9b95a3 100644 --- a/packages/ts-morph/src/structures/module/ModuleDeclarationStructure.ts +++ b/packages/ts-morph/src/structures/module/ModuleDeclarationStructure.ts @@ -1,11 +1,11 @@ import { ModuleDeclarationKind } from "../../compiler"; -import { AmbientableNodeStructure, ExportableNodeStructure, JSDocableNodeStructure, NamedNodeStructure } from "../base"; +import { AmbientableNodeStructure, ExportableNodeStructure, JSDocableNodeStructure, ModuleNamedNodeStructure } from "../base"; import { StatementedNodeStructure } from "../statement"; import { KindedStructure, Structure } from "../Structure"; import { StructureKind } from "../StructureKind"; export interface ModuleDeclarationStructure - extends Structure, NamedNodeStructure, ModuleDeclarationSpecificStructure, JSDocableNodeStructure, AmbientableNodeStructure, ExportableNodeStructure, + extends Structure, ModuleNamedNodeStructure, ModuleDeclarationSpecificStructure, JSDocableNodeStructure, AmbientableNodeStructure, ExportableNodeStructure, StatementedNodeStructure { } diff --git a/packages/ts-morph/src/tests/compiler/testHelpers/getInfoFromText.ts b/packages/ts-morph/src/tests/compiler/testHelpers/getInfoFromText.ts index 2c2d0f609..9e30793db 100644 --- a/packages/ts-morph/src/tests/compiler/testHelpers/getInfoFromText.ts +++ b/packages/ts-morph/src/tests/compiler/testHelpers/getInfoFromText.ts @@ -29,36 +29,10 @@ function getCompilerLibFolder(version: string) { } } -const libFileNames = [ - "lib.d.ts", - "lib.dom.d.ts", - "lib.scripthost.d.ts", - "lib.webworker.importscripts.d.ts", - "lib.es2017.full.d.ts", - "lib.es2017.object.d.ts", - "lib.es2017.sharedmemory.d.ts", - "lib.es2017.string.d.ts", - "lib.es2017.intl.d.ts", - "lib.es2016.d.ts", - "lib.es2015.d.ts", - "lib.es2015.core.d.ts", - "lib.es2015.collection.d.ts", - "lib.es2015.generator.d.ts", - "lib.es2015.promise.d.ts", - "lib.es2015.iterable.d.ts", - "lib.es2015.proxy.d.ts", - "lib.es2015.reflect.d.ts", - "lib.es2015.symbol.d.ts", - "lib.es2015.symbol.wellknown.d.ts", - "lib.es5.d.ts", -]; -const libFiles = libFileNames.map(name => getTextForLibFile(name)); - export interface GetInfoFromTextOptions { isDefinitionFile?: boolean; filePath?: string; host?: FileSystemHost; - disableErrorCheck?: boolean; compilerOptions?: CompilerOptions; includeLibDts?: boolean; isJsx?: boolean; @@ -107,18 +81,12 @@ function getInfoFromTextInternal(text: string, opts?: GetInfoFromTextOptions) { isDefinitionFile = false, isJsx = false, filePath = undefined, - host = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }), - disableErrorCheck = false, + host = new InMemoryFileSystemHost(), compilerOptions = undefined, includeLibDts = false, } = opts || {}; - if (includeLibDts) { - for (const libFile of libFiles) - host.writeFileSync(libFile.filePath, libFile.text); - } - - const project = new Project({ compilerOptions, fileSystem: host }); + const project = new Project({ compilerOptions, fileSystem: host, skipLoadingLibFiles: !includeLibDts }); const sourceFile = project.createSourceFile(getFilePath(), text); return { project, sourceFile }; diff --git a/packages/ts-morph/src/tests/compiler/tools/diagnosticTests.ts b/packages/ts-morph/src/tests/compiler/tools/diagnosticTests.ts index e5e765eb4..9b71118d5 100644 --- a/packages/ts-morph/src/tests/compiler/tools/diagnosticTests.ts +++ b/packages/ts-morph/src/tests/compiler/tools/diagnosticTests.ts @@ -4,7 +4,7 @@ import { Diagnostic } from "../../../compiler"; import { getInfoFromText } from "../testHelpers"; describe(nameof(Diagnostic), () => { - const { project, sourceFile } = getInfoFromText("const a: string;", { disableErrorCheck: true, includeLibDts: true }); + const { project, sourceFile } = getInfoFromText("const a: string;", { includeLibDts: true }); project.createSourceFile("file.ts", "interface MyInterface { declare prop: string; }"); const diagnostics = project.getPreEmitDiagnostics(); const constError = diagnostics[1]; diff --git a/packages/ts-morph/src/tests/compiler/type/typeTests.ts b/packages/ts-morph/src/tests/compiler/type/typeTests.ts index 3b1b5317f..9f533bdbb 100644 --- a/packages/ts-morph/src/tests/compiler/type/typeTests.ts +++ b/packages/ts-morph/src/tests/compiler/type/typeTests.ts @@ -6,7 +6,7 @@ import { getInfoFromText } from "../testHelpers"; describe(nameof(Type), () => { function getInfoFromTextWithTypeChecking(text: string) { return getInfoFromText(text, { - host: new InMemoryFileSystemHost({ skipLoadingLibFiles: true }), + host: new InMemoryFileSystemHost(), includeLibDts: true, compilerOptions: { strictNullChecks: true }, }); diff --git a/packages/ts-morph/src/tests/issues/394tests.ts b/packages/ts-morph/src/tests/issues/394tests.ts index 32a434ff0..b1c57d7aa 100644 --- a/packages/ts-morph/src/tests/issues/394tests.ts +++ b/packages/ts-morph/src/tests/issues/394tests.ts @@ -4,7 +4,7 @@ import { SourceFile } from "../../compiler"; import { Project } from "../../Project"; describe("tests for issue #394", () => { it("should get the original source file with correct casing when the module specifier has incorrect casing and using a case insensitive file system", () => { - const fileSystem = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }); + const fileSystem = new InMemoryFileSystemHost(); const sourceFiles: SourceFile[] = []; fileSystem.fileExistsSync = filePath => sourceFiles.some(s => s.getFilePath().toLowerCase() === filePath.toLowerCase()); fileSystem.readFileSync = filePath => { @@ -13,7 +13,7 @@ describe("tests for issue #394", () => { }; fileSystem.isCaseSensitive = () => false; - const project = new Project({ fileSystem }); + const project = new Project({ fileSystem, skipLoadingLibFiles: true }); const interfaceSourceFile = project.createSourceFile("/folder/MyInterface.ts", "export interface MyInterface {}"); const sourceFile = project.createSourceFile("/folder/main.ts", "import { MyInterface } from './myInterface';\n\nlet myVar: MyInterface;"); sourceFiles.push(interfaceSourceFile, sourceFile); diff --git a/packages/ts-morph/src/tests/issues/534tests.ts b/packages/ts-morph/src/tests/issues/534tests.ts index abb93aa5c..3de7ece3b 100644 --- a/packages/ts-morph/src/tests/issues/534tests.ts +++ b/packages/ts-morph/src/tests/issues/534tests.ts @@ -3,7 +3,7 @@ import { expect } from "chai"; import { Project } from "../../Project"; describe("tests for issue #534", () => { it("should use the tsconfig.json file path for type reference directive resolution", () => { - const fileSystem = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }); + const fileSystem = new InMemoryFileSystemHost(); fileSystem.mkdirSync("/dir"); fileSystem.mkdirSync("/dir/node_modules"); fileSystem.mkdirSync("/dir/node_modules/@types"); @@ -44,6 +44,7 @@ import { myExport } from "my-package"; const project = new Project({ fileSystem, tsConfigFilePath: "/dir/tsconfig.json", + skipLoadingLibFiles: true, }); const diagnostics = project.getPreEmitDiagnostics().filter(d => d.getCode() !== 2318); diff --git a/packages/ts-morph/src/tests/projectTests.ts b/packages/ts-morph/src/tests/projectTests.ts index b3dbdfab1..32da99334 100644 --- a/packages/ts-morph/src/tests/projectTests.ts +++ b/packages/ts-morph/src/tests/projectTests.ts @@ -1,4 +1,4 @@ -import { CompilerOptions, errors, InMemoryFileSystemHost, ScriptKind, ScriptTarget, SyntaxKind, ts } from "@ts-morph/common"; +import { CompilerOptions, errors, getLibFiles, InMemoryFileSystemHost, ScriptKind, ScriptTarget, SyntaxKind, ts } from "@ts-morph/common"; import { expect } from "chai"; import { assert, IsExact } from "conditional-type-checks"; import { EOL } from "os"; @@ -26,7 +26,7 @@ describe(nameof(Project), () => { }); it("should add the files from tsconfig.json by default with the target in the tsconfig.json", () => { - const fileSystem = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }); + const fileSystem = new InMemoryFileSystemHost(); fileSystem.writeFileSync("tsconfig.json", `{ "compilerOptions": { "rootDir": "test", "target": "ES5" }, "include": ["test"] }`); fileSystem.writeFileSync("/otherFile.ts", ""); fileSystem.writeFileSync("/test/file.ts", ""); @@ -37,7 +37,7 @@ describe(nameof(Project), () => { }); it("should add the files from tsconfig.json by default and also take into account the passed in compiler options", () => { - const fileSystem = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }); + const fileSystem = new InMemoryFileSystemHost(); fileSystem.writeFileSync("tsconfig.json", `{ "compilerOptions": { "target": "ES5" } }`); fileSystem.writeFileSync("/otherFile.ts", ""); fileSystem.writeFileSync("/test/file.ts", ""); @@ -47,7 +47,7 @@ describe(nameof(Project), () => { }); it("should not add the files from tsconfig.json when specifying not to", () => { - const fileSystem = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }); + const fileSystem = new InMemoryFileSystemHost(); fileSystem.writeFileSync("tsconfig.json", `{ "compilerOptions": { "rootDir": "test", "target": "ES5" } }`); fileSystem.writeFileSync("/test/file.ts", ""); fileSystem.writeFileSync("/test/test2/file2.ts", ""); @@ -161,7 +161,7 @@ describe(nameof(Project), () => { describe("custom type reference directive resolution", () => { function setup() { - const fileSystem = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }); + const fileSystem = new InMemoryFileSystemHost(); const testFilePath = "/other/test.d.ts"; fileSystem.writeFileSync("/dir/tsconfig.json", `{ "compilerOptions": { "target": "ES5" } }`); fileSystem.writeFileSync("/dir/main.ts", `/// \n\nconst test = new Test();`); @@ -190,6 +190,7 @@ describe(nameof(Project), () => { } }, tsConfigFilePath: "/dir/tsconfig.json", + skipLoadingLibFiles: true, }); const mainFile = project.getSourceFileOrThrow("main.ts"); @@ -214,18 +215,41 @@ describe(nameof(Project), () => { describe(nameof(o => o.skipLoadingLibFiles), () => { it("should not skip loading lib files when empty", () => { const project = new Project({ useInMemoryFileSystem: true }); - const result = project.getFileSystem().readDirSync("/node_modules/typescript/lib"); - expect(result.some(r => r.includes("lib.d.ts"))).to.be.true; + const sourceFile = project.createSourceFile("test.ts", "const t: String = '';"); + expect(project.getPreEmitDiagnostics().length).to.equal(0); + + const varDeclType = sourceFile.getVariableDeclarationOrThrow("t").getType(); + const stringDec = varDeclType.getSymbolOrThrow().getDeclarations()[0]; + expect(stringDec.getSourceFile().getFilePath()).to.equal("/node_modules/typescript/lib/lib.es5.d.ts"); }); - it("should not skip loading lib files when true", () => { + it("should skip loading lib files when true", () => { const project = new Project({ useInMemoryFileSystem: true, skipLoadingLibFiles: true }); - expect(project.getFileSystem().directoryExistsSync("/node_modules")).to.be.false; + const sourceFile = project.createSourceFile("test.ts", "const t: String = '';"); + expect(project.getPreEmitDiagnostics().length).to.equal(10); + + const varDeclType = sourceFile.getVariableDeclarationOrThrow("t").getType(); + expect(varDeclType.getSymbol()).to.be.undefined; + }); + + it("should throw when providing skipLoadingLibFiles and a libFolderPath", async () => { + expect(() => new Project({ skipLoadingLibFiles: true, libFolderPath: "/" })) + .to.throw("Cannot set skipLoadingLibFiles to true when libFolderPath is provided."); }); + }); - it("should throw when providing skipLoadingLibFiles without using n in-memory file system", () => { - expect(() => new Project({ skipLoadingLibFiles: true })) - .to.throw("The skipLoadingLibFiles option can only be true when useInMemoryFileSystem is true."); + describe(nameof(o => o.libFolderPath), () => { + it("should support specifying a different folder for the lib files", () => { + const fileSystem = new InMemoryFileSystemHost(); + for (const file of getLibFiles()) + fileSystem.writeFileSync(`/other/${file.fileName}`, file.text); + const project = new Project({ fileSystem, libFolderPath: "/other" }); + const sourceFile = project.createSourceFile("test.ts", "const t: String = '';"); + expect(project.getPreEmitDiagnostics().length).to.equal(0); + + const varDeclType = sourceFile.getVariableDeclarationOrThrow("t").getType(); + const stringDec = varDeclType.getSymbolOrThrow().getDeclarations()[0]; + expect(stringDec.getSourceFile().getFilePath()).to.equal("/other/lib.es5.d.ts"); }); }); }); @@ -294,13 +318,13 @@ describe(nameof(Project), () => { }); it("should ignore handle nested node_modules directories", () => { - const fileSystem = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }); + const fileSystem = new InMemoryFileSystemHost(); fileSystem.writeFileSync("/node_modules/first.d.ts", ""); fileSystem.writeFileSync("/node_modules/library/node_modules/second.d.ts", ""); fileSystem.writeFileSync("/main.ts", "/// \n/// "); - const project = new Project({ fileSystem }); + const project = new Project({ fileSystem, skipLoadingLibFiles: true }); project.addSourceFileAtPath("/main.ts"); project.resolveSourceFileDependencies(); assertHasSourceFiles(project, ["/main.ts"]); @@ -322,7 +346,7 @@ describe(nameof(Project), () => { }); function fileDependencyResolutionSetup(options: ProjectOptions = {}) { - const fileSystem = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }); + const fileSystem = new InMemoryFileSystemHost(); fileSystem.writeFileSync("/package.json", `{ "name": "testing", "version": "0.0.1" }`); fileSystem.writeFileSync("/node_modules/library/package.json", @@ -338,7 +362,12 @@ describe(nameof(Project), () => { fileSystem.writeFileSync("/other/referenced-file.d.ts", "declare function nameof(): void;"); fileSystem.writeFileSync("/tsconfig.json", `{ "files": ["src/main.ts"] }`); - const project = new Project({ tsConfigFilePath: "tsconfig.json", fileSystem, ...options }); + const project = new Project({ + tsConfigFilePath: "tsconfig.json", + fileSystem, + skipLoadingLibFiles: true, + ...options, + }); return { project, initialFiles: ["/src/main.ts"], @@ -661,13 +690,13 @@ describe(nameof(Project), () => { describe(nameof(project => project.addSourceFilesFromTsConfig), () => { it("should throw if the tsconfig doesn't exist", () => { - const fileSystem = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }); - const project = new Project({ fileSystem }); + const fileSystem = new InMemoryFileSystemHost(); + const project = new Project({ fileSystem, skipLoadingLibFiles: true }); expect(() => project.addSourceFilesFromTsConfig("tsconfig.json")).to.throw(errors.FileNotFoundError); }); it("should add the files from tsconfig.json", () => { - const fileSystem = new InMemoryFileSystemHost({ skipLoadingLibFiles: true }); + const fileSystem = new InMemoryFileSystemHost(); // todo: why did I need a slash at the start of `/test/exclude`? fileSystem.writeFileSync("tsconfig.json", `{ "compilerOptions": { "rootDir": "test", "target": "ES5" }, "include": ["test"], "exclude": ["/test/exclude"] }`); @@ -676,7 +705,7 @@ describe(nameof(Project), () => { fileSystem.writeFileSync("/test/test2/file2.ts", ""); fileSystem.writeFileSync("/test/exclude/file.ts", ""); fileSystem.mkdirSync("/test/emptyDir"); - const project = new Project({ fileSystem }); + const project = new Project({ fileSystem, skipLoadingLibFiles: true }); expect(project.getSourceFiles().map(s => s.getFilePath()).sort()).to.deep.equal([].sort()); expect(project.getDirectories().map(s => s.getPath()).sort()).to.deep.equal([].sort()); const returnedFiles = project.addSourceFilesFromTsConfig("tsconfig.json"); @@ -1540,7 +1569,6 @@ describe(nameof(Project), () => { expect(moduleResolutionHost.getDirectories!("/")).to.deep.equal([ "/dir1", "/dir2", - "/node_modules", ]); }); @@ -1553,7 +1581,6 @@ describe(nameof(Project), () => { "/dir1", "/dir2", "/dir3", - "/node_modules", ]); }); diff --git a/packages/ts-morph/src/tests/testHelpers/fileSystemHostHelpers.ts b/packages/ts-morph/src/tests/testHelpers/fileSystemHostHelpers.ts index 532050a8d..22bf6ecd7 100644 --- a/packages/ts-morph/src/tests/testHelpers/fileSystemHostHelpers.ts +++ b/packages/ts-morph/src/tests/testHelpers/fileSystemHostHelpers.ts @@ -27,7 +27,7 @@ class VirtualFileSystemForTest extends InMemoryFileSystemHost implements CustomF private readonly files = new KeyValueCache(); constructor(initialFiles: { filePath: string; text: string; }[], private readonly initialDirectories: string[] = []) { - super({ skipLoadingLibFiles: true }); + super(); for (const item of initialDirectories) this.trackedDirectories.add(item); diff --git a/packages/ts-morph/src/utils/compiler/createWrappedNode.ts b/packages/ts-morph/src/utils/compiler/createWrappedNode.ts index 4d3afddf6..acdcebc4a 100644 --- a/packages/ts-morph/src/utils/compiler/createWrappedNode.ts +++ b/packages/ts-morph/src/utils/compiler/createWrappedNode.ts @@ -33,6 +33,8 @@ export function createWrappedNode(node: T, opts: Cr createLanguageService: false, typeChecker, configFileParsingDiagnostics: [], + skipLoadingLibFiles: true, + libFolderPath: undefined, }); const wrappedSourceFile = projectContext.compilerFactory.getSourceFile(getSourceFileNode(), { markInProject: true });