+++ /dev/null
-/*! *****************************************************************************
-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 = "3.9";
- /** 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<T> {
- [index: string]: T;
- }
- interface SortedReadonlyArray<T> extends ReadonlyArray<T> {
- " __sortedArrayBrand": any;
- }
- interface SortedArray<T> extends Array<T> {
- " __sortedArrayBrand": any;
- }
- /** ES6 Map interface, only read methods included. */
- interface ReadonlyMap<T> {
- get(key: string): T | undefined;
- has(key: string): boolean;
- forEach(action: (value: T, key: string) => void): void;
- readonly size: number;
- keys(): Iterator<string>;
- values(): Iterator<T>;
- entries(): Iterator<[string, T]>;
- }
- /** ES6 Map interface. */
- interface Map<T> extends ReadonlyMap<T> {
- set(key: string, value: T): this;
- delete(key: string): boolean;
- clear(): void;
- }
- /** ES6 Iterator type. */
- interface Iterator<T> {
- next(): {
- value: T;
- done?: false;
- } | {
- value: never;
- done: true;
- };
- }
- /** Array that is only intended to be pushed to, never read. */
- interface Push<T> {
- push(...values: T[]): void;
- }
-}
-declare namespace ts {
- export type Path = string & {
- __pathBrand: any;
- };
- export interface TextRange {
- pos: number;
- end: number;
- }
- 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 type KeywordSyntaxKind = SyntaxKind.AbstractKeyword | SyntaxKind.AnyKeyword | SyntaxKind.AsKeyword | SyntaxKind.AssertsKeyword | SyntaxKind.BigIntKeyword | SyntaxKind.BooleanKeyword | SyntaxKind.BreakKeyword | SyntaxKind.CaseKeyword | SyntaxKind.CatchKeyword | SyntaxKind.ClassKeyword | SyntaxKind.ContinueKeyword | SyntaxKind.ConstKeyword | SyntaxKind.ConstructorKeyword | 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.IfKeyword | SyntaxKind.ImplementsKeyword | SyntaxKind.ImportKeyword | SyntaxKind.InKeyword | SyntaxKind.InferKeyword | SyntaxKind.InstanceOfKeyword | SyntaxKind.InterfaceKeyword | SyntaxKind.IsKeyword | SyntaxKind.KeyOfKeyword | SyntaxKind.LetKeyword | SyntaxKind.ModuleKeyword | SyntaxKind.NamespaceKeyword | SyntaxKind.NeverKeyword | SyntaxKind.NewKeyword | SyntaxKind.NullKeyword | SyntaxKind.NumberKeyword | SyntaxKind.ObjectKeyword | SyntaxKind.PackageKeyword | SyntaxKind.PrivateKeyword | SyntaxKind.ProtectedKeyword | SyntaxKind.PublicKeyword | SyntaxKind.ReadonlyKeyword | SyntaxKind.RequireKeyword | SyntaxKind.GlobalKeyword | 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 | SyntaxKind.AsyncKeyword | SyntaxKind.AwaitKeyword | SyntaxKind.OfKeyword;
- export type JsxTokenSyntaxKind = SyntaxKind.LessThanSlashToken | SyntaxKind.EndOfFileToken | SyntaxKind.ConflictMarkerTrivia | SyntaxKind.JsxText | SyntaxKind.JsxTextAllWhiteSpaces | SyntaxKind.OpenBraceToken | SyntaxKind.LessThanToken;
- 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,
- CaretEqualsToken = 74,
- Identifier = 75,
- PrivateIdentifier = 76,
- BreakKeyword = 77,
- CaseKeyword = 78,
- CatchKeyword = 79,
- ClassKeyword = 80,
- ConstKeyword = 81,
- ContinueKeyword = 82,
- DebuggerKeyword = 83,
- DefaultKeyword = 84,
- DeleteKeyword = 85,
- DoKeyword = 86,
- ElseKeyword = 87,
- EnumKeyword = 88,
- ExportKeyword = 89,
- ExtendsKeyword = 90,
- FalseKeyword = 91,
- FinallyKeyword = 92,
- ForKeyword = 93,
- FunctionKeyword = 94,
- IfKeyword = 95,
- ImportKeyword = 96,
- InKeyword = 97,
- InstanceOfKeyword = 98,
- NewKeyword = 99,
- NullKeyword = 100,
- ReturnKeyword = 101,
- SuperKeyword = 102,
- SwitchKeyword = 103,
- ThisKeyword = 104,
- ThrowKeyword = 105,
- TrueKeyword = 106,
- TryKeyword = 107,
- TypeOfKeyword = 108,
- VarKeyword = 109,
- VoidKeyword = 110,
- WhileKeyword = 111,
- WithKeyword = 112,
- ImplementsKeyword = 113,
- InterfaceKeyword = 114,
- LetKeyword = 115,
- PackageKeyword = 116,
- PrivateKeyword = 117,
- ProtectedKeyword = 118,
- PublicKeyword = 119,
- StaticKeyword = 120,
- YieldKeyword = 121,
- AbstractKeyword = 122,
- AsKeyword = 123,
- AssertsKeyword = 124,
- AnyKeyword = 125,
- AsyncKeyword = 126,
- AwaitKeyword = 127,
- BooleanKeyword = 128,
- ConstructorKeyword = 129,
- DeclareKeyword = 130,
- GetKeyword = 131,
- InferKeyword = 132,
- IsKeyword = 133,
- KeyOfKeyword = 134,
- ModuleKeyword = 135,
- NamespaceKeyword = 136,
- NeverKeyword = 137,
- ReadonlyKeyword = 138,
- RequireKeyword = 139,
- NumberKeyword = 140,
- ObjectKeyword = 141,
- SetKeyword = 142,
- StringKeyword = 143,
- SymbolKeyword = 144,
- TypeKeyword = 145,
- UndefinedKeyword = 146,
- UniqueKeyword = 147,
- UnknownKeyword = 148,
- FromKeyword = 149,
- GlobalKeyword = 150,
- BigIntKeyword = 151,
- OfKeyword = 152,
- QualifiedName = 153,
- ComputedPropertyName = 154,
- TypeParameter = 155,
- Parameter = 156,
- Decorator = 157,
- PropertySignature = 158,
- PropertyDeclaration = 159,
- MethodSignature = 160,
- MethodDeclaration = 161,
- Constructor = 162,
- GetAccessor = 163,
- SetAccessor = 164,
- CallSignature = 165,
- ConstructSignature = 166,
- IndexSignature = 167,
- TypePredicate = 168,
- TypeReference = 169,
- FunctionType = 170,
- ConstructorType = 171,
- TypeQuery = 172,
- TypeLiteral = 173,
- ArrayType = 174,
- TupleType = 175,
- OptionalType = 176,
- RestType = 177,
- UnionType = 178,
- IntersectionType = 179,
- ConditionalType = 180,
- InferType = 181,
- ParenthesizedType = 182,
- ThisType = 183,
- TypeOperator = 184,
- IndexedAccessType = 185,
- MappedType = 186,
- LiteralType = 187,
- ImportType = 188,
- ObjectBindingPattern = 189,
- ArrayBindingPattern = 190,
- BindingElement = 191,
- ArrayLiteralExpression = 192,
- ObjectLiteralExpression = 193,
- PropertyAccessExpression = 194,
- ElementAccessExpression = 195,
- CallExpression = 196,
- NewExpression = 197,
- TaggedTemplateExpression = 198,
- TypeAssertionExpression = 199,
- ParenthesizedExpression = 200,
- FunctionExpression = 201,
- ArrowFunction = 202,
- DeleteExpression = 203,
- TypeOfExpression = 204,
- VoidExpression = 205,
- AwaitExpression = 206,
- PrefixUnaryExpression = 207,
- PostfixUnaryExpression = 208,
- BinaryExpression = 209,
- ConditionalExpression = 210,
- TemplateExpression = 211,
- YieldExpression = 212,
- SpreadElement = 213,
- ClassExpression = 214,
- OmittedExpression = 215,
- ExpressionWithTypeArguments = 216,
- AsExpression = 217,
- NonNullExpression = 218,
- MetaProperty = 219,
- SyntheticExpression = 220,
- TemplateSpan = 221,
- SemicolonClassElement = 222,
- Block = 223,
- EmptyStatement = 224,
- VariableStatement = 225,
- ExpressionStatement = 226,
- IfStatement = 227,
- DoStatement = 228,
- WhileStatement = 229,
- ForStatement = 230,
- ForInStatement = 231,
- ForOfStatement = 232,
- ContinueStatement = 233,
- BreakStatement = 234,
- ReturnStatement = 235,
- WithStatement = 236,
- SwitchStatement = 237,
- LabeledStatement = 238,
- ThrowStatement = 239,
- TryStatement = 240,
- DebuggerStatement = 241,
- VariableDeclaration = 242,
- VariableDeclarationList = 243,
- FunctionDeclaration = 244,
- ClassDeclaration = 245,
- InterfaceDeclaration = 246,
- TypeAliasDeclaration = 247,
- EnumDeclaration = 248,
- ModuleDeclaration = 249,
- ModuleBlock = 250,
- CaseBlock = 251,
- NamespaceExportDeclaration = 252,
- ImportEqualsDeclaration = 253,
- ImportDeclaration = 254,
- ImportClause = 255,
- NamespaceImport = 256,
- NamedImports = 257,
- ImportSpecifier = 258,
- ExportAssignment = 259,
- ExportDeclaration = 260,
- NamedExports = 261,
- NamespaceExport = 262,
- ExportSpecifier = 263,
- MissingDeclaration = 264,
- ExternalModuleReference = 265,
- JsxElement = 266,
- JsxSelfClosingElement = 267,
- JsxOpeningElement = 268,
- JsxClosingElement = 269,
- JsxFragment = 270,
- JsxOpeningFragment = 271,
- JsxClosingFragment = 272,
- JsxAttribute = 273,
- JsxAttributes = 274,
- JsxSpreadAttribute = 275,
- JsxExpression = 276,
- CaseClause = 277,
- DefaultClause = 278,
- HeritageClause = 279,
- CatchClause = 280,
- PropertyAssignment = 281,
- ShorthandPropertyAssignment = 282,
- SpreadAssignment = 283,
- EnumMember = 284,
- UnparsedPrologue = 285,
- UnparsedPrepend = 286,
- UnparsedText = 287,
- UnparsedInternalText = 288,
- UnparsedSyntheticReference = 289,
- SourceFile = 290,
- Bundle = 291,
- UnparsedSource = 292,
- InputFiles = 293,
- JSDocTypeExpression = 294,
- JSDocAllType = 295,
- JSDocUnknownType = 296,
- JSDocNullableType = 297,
- JSDocNonNullableType = 298,
- JSDocOptionalType = 299,
- JSDocFunctionType = 300,
- JSDocVariadicType = 301,
- JSDocNamepathType = 302,
- JSDocComment = 303,
- JSDocTypeLiteral = 304,
- JSDocSignature = 305,
- JSDocTag = 306,
- JSDocAugmentsTag = 307,
- JSDocImplementsTag = 308,
- JSDocAuthorTag = 309,
- JSDocClassTag = 310,
- JSDocPublicTag = 311,
- JSDocPrivateTag = 312,
- JSDocProtectedTag = 313,
- JSDocReadonlyTag = 314,
- JSDocCallbackTag = 315,
- JSDocEnumTag = 316,
- JSDocParameterTag = 317,
- JSDocReturnTag = 318,
- JSDocThisTag = 319,
- JSDocTypeTag = 320,
- JSDocTemplateTag = 321,
- JSDocTypedefTag = 322,
- JSDocPropertyTag = 323,
- SyntaxList = 324,
- NotEmittedStatement = 325,
- PartiallyEmittedExpression = 326,
- CommaListExpression = 327,
- MergeDeclarationMarker = 328,
- EndOfDeclarationMarker = 329,
- SyntheticReferenceExpression = 330,
- Count = 331,
- FirstAssignment = 62,
- LastAssignment = 74,
- FirstCompoundAssignment = 63,
- LastCompoundAssignment = 74,
- FirstReservedWord = 77,
- LastReservedWord = 112,
- FirstKeyword = 77,
- LastKeyword = 152,
- FirstFutureReservedWord = 113,
- LastFutureReservedWord = 121,
- FirstTypeNode = 168,
- LastTypeNode = 188,
- FirstPunctuation = 18,
- LastPunctuation = 74,
- FirstToken = 0,
- LastToken = 152,
- FirstTriviaToken = 2,
- LastTriviaToken = 7,
- FirstLiteralToken = 8,
- LastLiteralToken = 14,
- FirstTemplateToken = 14,
- LastTemplateToken = 17,
- FirstBinaryOperator = 29,
- LastBinaryOperator = 74,
- FirstStatement = 225,
- LastStatement = 241,
- FirstNode = 153,
- FirstJSDocNode = 294,
- LastJSDocNode = 323,
- FirstJSDocTagNode = 306,
- LastJSDocTagNode = 323,
- }
- 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,
- HasComputedFlags = 536870912,
- AccessibilityModifier = 28,
- ParameterPropertyModifier = 92,
- NonPublicAccessibilityModifier = 24,
- TypeScriptModifier = 2270,
- ExportDefault = 513,
- All = 3071
- }
- 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 TextRange {
- kind: SyntaxKind;
- flags: NodeFlags;
- decorators?: NodeArray<Decorator>;
- modifiers?: ModifiersArray;
- 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 | IndexSignatureDeclaration | FunctionTypeNode | ConstructorTypeNode | JSDocFunctionType | ExportDeclaration | 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<T extends Node> extends ReadonlyArray<T>, TextRange {
- hasTrailingComma?: boolean;
- }
- export interface Token<TKind extends SyntaxKind> extends Node {
- kind: TKind;
- }
- export type DotToken = Token<SyntaxKind.DotToken>;
- export type DotDotDotToken = Token<SyntaxKind.DotDotDotToken>;
- export type QuestionToken = Token<SyntaxKind.QuestionToken>;
- export type QuestionDotToken = Token<SyntaxKind.QuestionDotToken>;
- export type ExclamationToken = Token<SyntaxKind.ExclamationToken>;
- export type ColonToken = Token<SyntaxKind.ColonToken>;
- export type EqualsToken = Token<SyntaxKind.EqualsToken>;
- export type AsteriskToken = Token<SyntaxKind.AsteriskToken>;
- export type EqualsGreaterThanToken = Token<SyntaxKind.EqualsGreaterThanToken>;
- export type EndOfFileToken = Token<SyntaxKind.EndOfFileToken> & JSDocContainer;
- export type ReadonlyToken = Token<SyntaxKind.ReadonlyKeyword>;
- export type AwaitKeywordToken = Token<SyntaxKind.AwaitKeyword>;
- export type PlusToken = Token<SyntaxKind.PlusToken>;
- export type MinusToken = Token<SyntaxKind.MinusToken>;
- export type AssertsToken = Token<SyntaxKind.AssertsKeyword>;
- export type Modifier = Token<SyntaxKind.AbstractKeyword> | Token<SyntaxKind.AsyncKeyword> | Token<SyntaxKind.ConstKeyword> | Token<SyntaxKind.DeclareKeyword> | Token<SyntaxKind.DefaultKeyword> | Token<SyntaxKind.ExportKeyword> | Token<SyntaxKind.PublicKeyword> | Token<SyntaxKind.PrivateKeyword> | Token<SyntaxKind.ProtectedKeyword> | Token<SyntaxKind.ReadonlyKeyword> | Token<SyntaxKind.StaticKeyword>;
- export type ModifiersArray = NodeArray<Modifier>;
- export interface Identifier extends PrimaryExpression, Declaration {
- 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.
- */
- escapedText: __String;
- originalKeywordKind?: SyntaxKind;
- isInJSDocNamespace?: boolean;
- }
- export interface TransientIdentifier extends Identifier {
- resolvedSymbol: Symbol;
- }
- export interface QualifiedName extends Node {
- kind: SyntaxKind.QualifiedName;
- left: EntityName;
- 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 {
- name?: DeclarationName;
- }
- export interface DeclarationStatement extends NamedDeclaration, Statement {
- name?: Identifier | StringLiteral | NumericLiteral;
- }
- export interface ComputedPropertyName extends Node {
- parent: Declaration;
- kind: SyntaxKind.ComputedPropertyName;
- expression: Expression;
- }
- export interface PrivateIdentifier extends Node {
- kind: SyntaxKind.PrivateIdentifier;
- escapedText: __String;
- }
- export interface Decorator extends Node {
- kind: SyntaxKind.Decorator;
- parent: NamedDeclaration;
- expression: LeftHandSideExpression;
- }
- export interface TypeParameterDeclaration extends NamedDeclaration {
- kind: SyntaxKind.TypeParameter;
- parent: DeclarationWithTypeParameterChildren | InferTypeNode;
- name: Identifier;
- /** Note: Consider calling `getEffectiveConstraintOfTypeParameter` */
- constraint?: TypeNode;
- default?: TypeNode;
- expression?: Expression;
- }
- export interface SignatureDeclarationBase extends NamedDeclaration, JSDocContainer {
- kind: SignatureDeclaration["kind"];
- name?: PropertyName;
- typeParameters?: NodeArray<TypeParameterDeclaration>;
- parameters: NodeArray<ParameterDeclaration>;
- type?: TypeNode;
- }
- export type SignatureDeclaration = CallSignatureDeclaration | ConstructSignatureDeclaration | MethodSignature | IndexSignatureDeclaration | FunctionTypeNode | ConstructorTypeNode | JSDocFunctionType | FunctionDeclaration | MethodDeclaration | ConstructorDeclaration | AccessorDeclaration | FunctionExpression | ArrowFunction;
- export interface CallSignatureDeclaration extends SignatureDeclarationBase, TypeElement {
- kind: SyntaxKind.CallSignature;
- }
- export interface ConstructSignatureDeclaration extends SignatureDeclarationBase, TypeElement {
- kind: SyntaxKind.ConstructSignature;
- }
- export type BindingName = Identifier | BindingPattern;
- export interface VariableDeclaration extends NamedDeclaration {
- kind: SyntaxKind.VariableDeclaration;
- parent: VariableDeclarationList | CatchClause;
- name: BindingName;
- exclamationToken?: ExclamationToken;
- type?: TypeNode;
- initializer?: Expression;
- }
- export interface VariableDeclarationList extends Node {
- kind: SyntaxKind.VariableDeclarationList;
- parent: VariableStatement | ForStatement | ForOfStatement | ForInStatement;
- declarations: NodeArray<VariableDeclaration>;
- }
- export interface ParameterDeclaration extends NamedDeclaration, JSDocContainer {
- kind: SyntaxKind.Parameter;
- parent: SignatureDeclaration;
- dotDotDotToken?: DotDotDotToken;
- name: BindingName;
- questionToken?: QuestionToken;
- type?: TypeNode;
- initializer?: Expression;
- }
- export interface BindingElement extends NamedDeclaration {
- kind: SyntaxKind.BindingElement;
- parent: BindingPattern;
- propertyName?: PropertyName;
- dotDotDotToken?: DotDotDotToken;
- name: BindingName;
- initializer?: Expression;
- }
- export interface PropertySignature extends TypeElement, JSDocContainer {
- kind: SyntaxKind.PropertySignature;
- name: PropertyName;
- questionToken?: QuestionToken;
- type?: TypeNode;
- initializer?: Expression;
- }
- export interface PropertyDeclaration extends ClassElement, JSDocContainer {
- kind: SyntaxKind.PropertyDeclaration;
- parent: ClassLikeDeclaration;
- name: PropertyName;
- questionToken?: QuestionToken;
- exclamationToken?: ExclamationToken;
- type?: TypeNode;
- initializer?: Expression;
- }
- export interface ObjectLiteralElement extends NamedDeclaration {
- _objectLiteralBrand: any;
- name?: PropertyName;
- }
- /** Unlike ObjectLiteralElement, excludes JSXAttribute and JSXSpreadAttribute. */
- export type ObjectLiteralElementLike = PropertyAssignment | ShorthandPropertyAssignment | SpreadAssignment | MethodDeclaration | AccessorDeclaration;
- export interface PropertyAssignment extends ObjectLiteralElement, JSDocContainer {
- parent: ObjectLiteralExpression;
- kind: SyntaxKind.PropertyAssignment;
- name: PropertyName;
- questionToken?: QuestionToken;
- initializer: Expression;
- }
- export interface ShorthandPropertyAssignment extends ObjectLiteralElement, JSDocContainer {
- parent: ObjectLiteralExpression;
- kind: SyntaxKind.ShorthandPropertyAssignment;
- name: Identifier;
- questionToken?: QuestionToken;
- exclamationToken?: ExclamationToken;
- equalsToken?: Token<SyntaxKind.EqualsToken>;
- objectAssignmentInitializer?: Expression;
- }
- export interface SpreadAssignment extends ObjectLiteralElement, JSDocContainer {
- parent: ObjectLiteralExpression;
- kind: SyntaxKind.SpreadAssignment;
- expression: Expression;
- }
- export type VariableLikeDeclaration = VariableDeclaration | ParameterDeclaration | BindingElement | PropertyDeclaration | PropertyAssignment | PropertySignature | JsxAttribute | ShorthandPropertyAssignment | EnumMember | JSDocPropertyTag | JSDocParameterTag;
- export interface PropertyLikeDeclaration extends NamedDeclaration {
- name: PropertyName;
- }
- export interface ObjectBindingPattern extends Node {
- kind: SyntaxKind.ObjectBindingPattern;
- parent: VariableDeclaration | ParameterDeclaration | BindingElement;
- elements: NodeArray<BindingElement>;
- }
- export interface ArrayBindingPattern extends Node {
- kind: SyntaxKind.ArrayBindingPattern;
- parent: VariableDeclaration | ParameterDeclaration | BindingElement;
- elements: NodeArray<ArrayBindingElement>;
- }
- 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;
- asteriskToken?: AsteriskToken;
- questionToken?: QuestionToken;
- exclamationToken?: ExclamationToken;
- 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 {
- kind: SyntaxKind.FunctionDeclaration;
- name?: Identifier;
- body?: FunctionBody;
- }
- export interface MethodSignature extends SignatureDeclarationBase, TypeElement {
- kind: SyntaxKind.MethodSignature;
- parent: ObjectTypeDeclaration;
- name: PropertyName;
- }
- export interface MethodDeclaration extends FunctionLikeDeclarationBase, ClassElement, ObjectLiteralElement, JSDocContainer {
- kind: SyntaxKind.MethodDeclaration;
- parent: ClassLikeDeclaration | ObjectLiteralExpression;
- name: PropertyName;
- body?: FunctionBody;
- }
- export interface ConstructorDeclaration extends FunctionLikeDeclarationBase, ClassElement, JSDocContainer {
- kind: SyntaxKind.Constructor;
- parent: ClassLikeDeclaration;
- body?: FunctionBody;
- }
- /** For when we encounter a semicolon in a class declaration. ES6 allows these as class elements. */
- export interface SemicolonClassElement extends ClassElement {
- kind: SyntaxKind.SemicolonClassElement;
- parent: ClassLikeDeclaration;
- }
- export interface GetAccessorDeclaration extends FunctionLikeDeclarationBase, ClassElement, ObjectLiteralElement, JSDocContainer {
- kind: SyntaxKind.GetAccessor;
- parent: ClassLikeDeclaration | ObjectLiteralExpression;
- name: PropertyName;
- body?: FunctionBody;
- }
- export interface SetAccessorDeclaration extends FunctionLikeDeclarationBase, ClassElement, ObjectLiteralElement, JSDocContainer {
- kind: SyntaxKind.SetAccessor;
- parent: ClassLikeDeclaration | ObjectLiteralExpression;
- name: PropertyName;
- body?: FunctionBody;
- }
- export type AccessorDeclaration = GetAccessorDeclaration | SetAccessorDeclaration;
- export interface IndexSignatureDeclaration extends SignatureDeclarationBase, ClassElement, TypeElement {
- kind: SyntaxKind.IndexSignature;
- parent: ObjectTypeDeclaration;
- }
- export interface TypeNode extends Node {
- _typeNodeBrand: any;
- }
- export interface KeywordTypeNode extends TypeNode {
- kind: SyntaxKind.AnyKeyword | SyntaxKind.UnknownKeyword | SyntaxKind.NumberKeyword | SyntaxKind.BigIntKeyword | SyntaxKind.ObjectKeyword | SyntaxKind.BooleanKeyword | SyntaxKind.StringKeyword | SyntaxKind.SymbolKeyword | SyntaxKind.ThisKeyword | SyntaxKind.VoidKeyword | SyntaxKind.UndefinedKeyword | SyntaxKind.NullKeyword | SyntaxKind.NeverKeyword;
- }
- export interface ImportTypeNode extends NodeWithTypeArguments {
- kind: SyntaxKind.ImportType;
- isTypeOf?: boolean;
- argument: TypeNode;
- qualifier?: EntityName;
- }
- export interface ThisTypeNode extends TypeNode {
- kind: SyntaxKind.ThisType;
- }
- export type FunctionOrConstructorTypeNode = FunctionTypeNode | ConstructorTypeNode;
- export interface FunctionOrConstructorTypeNodeBase extends TypeNode, SignatureDeclarationBase {
- kind: SyntaxKind.FunctionType | SyntaxKind.ConstructorType;
- type: TypeNode;
- }
- export interface FunctionTypeNode extends FunctionOrConstructorTypeNodeBase {
- kind: SyntaxKind.FunctionType;
- }
- export interface ConstructorTypeNode extends FunctionOrConstructorTypeNodeBase {
- kind: SyntaxKind.ConstructorType;
- }
- export interface NodeWithTypeArguments extends TypeNode {
- typeArguments?: NodeArray<TypeNode>;
- }
- export type TypeReferenceType = TypeReferenceNode | ExpressionWithTypeArguments;
- export interface TypeReferenceNode extends NodeWithTypeArguments {
- kind: SyntaxKind.TypeReference;
- typeName: EntityName;
- }
- export interface TypePredicateNode extends TypeNode {
- kind: SyntaxKind.TypePredicate;
- parent: SignatureDeclaration | JSDocTypeExpression;
- assertsModifier?: AssertsToken;
- parameterName: Identifier | ThisTypeNode;
- type?: TypeNode;
- }
- export interface TypeQueryNode extends TypeNode {
- kind: SyntaxKind.TypeQuery;
- exprName: EntityName;
- }
- export interface TypeLiteralNode extends TypeNode, Declaration {
- kind: SyntaxKind.TypeLiteral;
- members: NodeArray<TypeElement>;
- }
- export interface ArrayTypeNode extends TypeNode {
- kind: SyntaxKind.ArrayType;
- elementType: TypeNode;
- }
- export interface TupleTypeNode extends TypeNode {
- kind: SyntaxKind.TupleType;
- elementTypes: NodeArray<TypeNode>;
- }
- export interface OptionalTypeNode extends TypeNode {
- kind: SyntaxKind.OptionalType;
- type: TypeNode;
- }
- export interface RestTypeNode extends TypeNode {
- kind: SyntaxKind.RestType;
- type: TypeNode;
- }
- export type UnionOrIntersectionTypeNode = UnionTypeNode | IntersectionTypeNode;
- export interface UnionTypeNode extends TypeNode {
- kind: SyntaxKind.UnionType;
- types: NodeArray<TypeNode>;
- }
- export interface IntersectionTypeNode extends TypeNode {
- kind: SyntaxKind.IntersectionType;
- types: NodeArray<TypeNode>;
- }
- export interface ConditionalTypeNode extends TypeNode {
- kind: SyntaxKind.ConditionalType;
- checkType: TypeNode;
- extendsType: TypeNode;
- trueType: TypeNode;
- falseType: TypeNode;
- }
- export interface InferTypeNode extends TypeNode {
- kind: SyntaxKind.InferType;
- typeParameter: TypeParameterDeclaration;
- }
- export interface ParenthesizedTypeNode extends TypeNode {
- kind: SyntaxKind.ParenthesizedType;
- type: TypeNode;
- }
- export interface TypeOperatorNode extends TypeNode {
- kind: SyntaxKind.TypeOperator;
- operator: SyntaxKind.KeyOfKeyword | SyntaxKind.UniqueKeyword | SyntaxKind.ReadonlyKeyword;
- type: TypeNode;
- }
- export interface IndexedAccessTypeNode extends TypeNode {
- kind: SyntaxKind.IndexedAccessType;
- objectType: TypeNode;
- indexType: TypeNode;
- }
- export interface MappedTypeNode extends TypeNode, Declaration {
- kind: SyntaxKind.MappedType;
- readonlyToken?: ReadonlyToken | PlusToken | MinusToken;
- typeParameter: TypeParameterDeclaration;
- questionToken?: QuestionToken | PlusToken | MinusToken;
- type?: TypeNode;
- }
- export interface LiteralTypeNode extends TypeNode {
- kind: SyntaxKind.LiteralType;
- literal: BooleanLiteral | LiteralExpression | PrefixUnaryExpression;
- }
- export interface StringLiteral extends LiteralExpression, Declaration {
- kind: SyntaxKind.StringLiteral;
- }
- export type StringLiteralLike = StringLiteral | NoSubstitutionTemplateLiteral;
- export interface Expression extends Node {
- _expressionBrand: any;
- }
- export interface OmittedExpression extends Expression {
- kind: SyntaxKind.OmittedExpression;
- }
- export interface PartiallyEmittedExpression extends LeftHandSideExpression {
- kind: SyntaxKind.PartiallyEmittedExpression;
- 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 {
- kind: SyntaxKind.PrefixUnaryExpression;
- operator: PrefixUnaryOperator;
- operand: UnaryExpression;
- }
- export type PostfixUnaryOperator = SyntaxKind.PlusPlusToken | SyntaxKind.MinusMinusToken;
- export interface PostfixUnaryExpression extends UpdateExpression {
- kind: SyntaxKind.PostfixUnaryExpression;
- operand: LeftHandSideExpression;
- 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, TypeNode {
- kind: SyntaxKind.NullKeyword;
- }
- export interface BooleanLiteral extends PrimaryExpression, TypeNode {
- kind: SyntaxKind.TrueKeyword | SyntaxKind.FalseKeyword;
- }
- export interface ThisExpression extends PrimaryExpression, KeywordTypeNode {
- kind: SyntaxKind.ThisKeyword;
- }
- export interface SuperExpression extends PrimaryExpression {
- kind: SyntaxKind.SuperKeyword;
- }
- export interface ImportExpression extends PrimaryExpression {
- kind: SyntaxKind.ImportKeyword;
- }
- export interface DeleteExpression extends UnaryExpression {
- kind: SyntaxKind.DeleteExpression;
- expression: UnaryExpression;
- }
- export interface TypeOfExpression extends UnaryExpression {
- kind: SyntaxKind.TypeOfExpression;
- expression: UnaryExpression;
- }
- export interface VoidExpression extends UnaryExpression {
- kind: SyntaxKind.VoidExpression;
- expression: UnaryExpression;
- }
- export interface AwaitExpression extends UnaryExpression {
- kind: SyntaxKind.AwaitExpression;
- expression: UnaryExpression;
- }
- export interface YieldExpression extends Expression {
- kind: SyntaxKind.YieldExpression;
- asteriskToken?: AsteriskToken;
- expression?: Expression;
- }
- export interface SyntheticExpression extends Expression {
- kind: SyntaxKind.SyntheticExpression;
- isSpread: boolean;
- type: Type;
- }
- 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;
- export type AssignmentOperator = SyntaxKind.EqualsToken | CompoundAssignmentOperator;
- export type AssignmentOperatorOrHigher = SyntaxKind.QuestionQuestionToken | LogicalOperatorOrHigher | AssignmentOperator;
- export type BinaryOperator = AssignmentOperatorOrHigher | SyntaxKind.CommaToken;
- export type BinaryOperatorToken = Token<BinaryOperator>;
- export interface BinaryExpression extends Expression, Declaration {
- kind: SyntaxKind.BinaryExpression;
- left: Expression;
- operatorToken: BinaryOperatorToken;
- right: Expression;
- }
- export type AssignmentOperatorToken = Token<AssignmentOperator>;
- export interface AssignmentExpression<TOperator extends AssignmentOperatorToken> extends BinaryExpression {
- left: LeftHandSideExpression;
- operatorToken: TOperator;
- }
- export interface ObjectDestructuringAssignment extends AssignmentExpression<EqualsToken> {
- left: ObjectLiteralExpression;
- }
- export interface ArrayDestructuringAssignment extends AssignmentExpression<EqualsToken> {
- left: ArrayLiteralExpression;
- }
- export type DestructuringAssignment = ObjectDestructuringAssignment | ArrayDestructuringAssignment;
- export type BindingOrAssignmentElement = VariableDeclaration | ParameterDeclaration | BindingElement | PropertyAssignment | ShorthandPropertyAssignment | SpreadAssignment | OmittedExpression | SpreadElement | ArrayLiteralExpression | ObjectLiteralExpression | AssignmentExpression<EqualsToken> | 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 {
- kind: SyntaxKind.ConditionalExpression;
- condition: Expression;
- questionToken: QuestionToken;
- whenTrue: Expression;
- colonToken: ColonToken;
- whenFalse: Expression;
- }
- export type FunctionBody = Block;
- export type ConciseBody = FunctionBody | Expression;
- export interface FunctionExpression extends PrimaryExpression, FunctionLikeDeclarationBase, JSDocContainer {
- kind: SyntaxKind.FunctionExpression;
- name?: Identifier;
- body: FunctionBody;
- }
- export interface ArrowFunction extends Expression, FunctionLikeDeclarationBase, JSDocContainer {
- kind: SyntaxKind.ArrowFunction;
- equalsGreaterThanToken: EqualsGreaterThanToken;
- body: ConciseBody;
- 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 {
- kind: SyntaxKind.RegularExpressionLiteral;
- }
- export interface NoSubstitutionTemplateLiteral extends LiteralExpression, TemplateLiteralLikeNode, Declaration {
- kind: SyntaxKind.NoSubstitutionTemplateLiteral;
- }
- export enum TokenFlags {
- None = 0,
- Scientific = 16,
- Octal = 32,
- HexSpecifier = 64,
- BinarySpecifier = 128,
- OctalSpecifier = 256,
- }
- export interface NumericLiteral extends LiteralExpression, Declaration {
- kind: SyntaxKind.NumericLiteral;
- }
- export interface BigIntLiteral extends LiteralExpression {
- kind: SyntaxKind.BigIntLiteral;
- }
- export interface TemplateHead extends TemplateLiteralLikeNode {
- kind: SyntaxKind.TemplateHead;
- parent: TemplateExpression;
- }
- export interface TemplateMiddle extends TemplateLiteralLikeNode {
- kind: SyntaxKind.TemplateMiddle;
- parent: TemplateSpan;
- }
- export interface TemplateTail extends TemplateLiteralLikeNode {
- kind: SyntaxKind.TemplateTail;
- parent: TemplateSpan;
- }
- export type TemplateLiteral = TemplateExpression | NoSubstitutionTemplateLiteral;
- export interface TemplateExpression extends PrimaryExpression {
- kind: SyntaxKind.TemplateExpression;
- head: TemplateHead;
- templateSpans: NodeArray<TemplateSpan>;
- }
- export interface TemplateSpan extends Node {
- kind: SyntaxKind.TemplateSpan;
- parent: TemplateExpression;
- expression: Expression;
- literal: TemplateMiddle | TemplateTail;
- }
- export interface ParenthesizedExpression extends PrimaryExpression, JSDocContainer {
- kind: SyntaxKind.ParenthesizedExpression;
- expression: Expression;
- }
- export interface ArrayLiteralExpression extends PrimaryExpression {
- kind: SyntaxKind.ArrayLiteralExpression;
- elements: NodeArray<Expression>;
- }
- export interface SpreadElement extends Expression {
- kind: SyntaxKind.SpreadElement;
- parent: ArrayLiteralExpression | CallExpression | NewExpression;
- 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<T extends ObjectLiteralElement> extends PrimaryExpression, Declaration {
- properties: NodeArray<T>;
- }
- export interface ObjectLiteralExpression extends ObjectLiteralExpressionBase<ObjectLiteralElementLike> {
- kind: SyntaxKind.ObjectLiteralExpression;
- }
- export type EntityNameExpression = Identifier | PropertyAccessEntityNameExpression;
- export type EntityNameOrEntityNameExpression = EntityName | EntityNameExpression;
- export interface PropertyAccessExpression extends MemberExpression, NamedDeclaration {
- kind: SyntaxKind.PropertyAccessExpression;
- expression: LeftHandSideExpression;
- questionDotToken?: QuestionDotToken;
- name: Identifier | PrivateIdentifier;
- }
- export interface PropertyAccessChain extends PropertyAccessExpression {
- _optionalChainBrand: any;
- name: Identifier;
- }
- export interface SuperPropertyAccessExpression extends PropertyAccessExpression {
- 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;
- expression: EntityNameExpression;
- name: Identifier;
- }
- export interface ElementAccessExpression extends MemberExpression {
- kind: SyntaxKind.ElementAccessExpression;
- expression: LeftHandSideExpression;
- questionDotToken?: QuestionDotToken;
- argumentExpression: Expression;
- }
- export interface ElementAccessChain extends ElementAccessExpression {
- _optionalChainBrand: any;
- }
- export interface SuperElementAccessExpression extends ElementAccessExpression {
- expression: SuperExpression;
- }
- export type SuperProperty = SuperPropertyAccessExpression | SuperElementAccessExpression;
- export interface CallExpression extends LeftHandSideExpression, Declaration {
- kind: SyntaxKind.CallExpression;
- expression: LeftHandSideExpression;
- questionDotToken?: QuestionDotToken;
- typeArguments?: NodeArray<TypeNode>;
- arguments: NodeArray<Expression>;
- }
- export interface CallChain extends CallExpression {
- _optionalChainBrand: any;
- }
- export type OptionalChain = PropertyAccessChain | ElementAccessChain | CallChain | NonNullChain;
- export interface SuperCall extends CallExpression {
- expression: SuperExpression;
- }
- export interface ImportCall extends CallExpression {
- expression: ImportExpression;
- }
- export interface ExpressionWithTypeArguments extends NodeWithTypeArguments {
- kind: SyntaxKind.ExpressionWithTypeArguments;
- parent: HeritageClause | JSDocAugmentsTag | JSDocImplementsTag;
- expression: LeftHandSideExpression;
- }
- export interface NewExpression extends PrimaryExpression, Declaration {
- kind: SyntaxKind.NewExpression;
- expression: LeftHandSideExpression;
- typeArguments?: NodeArray<TypeNode>;
- arguments?: NodeArray<Expression>;
- }
- export interface TaggedTemplateExpression extends MemberExpression {
- kind: SyntaxKind.TaggedTemplateExpression;
- tag: LeftHandSideExpression;
- typeArguments?: NodeArray<TypeNode>;
- template: TemplateLiteral;
- }
- export type CallLikeExpression = CallExpression | NewExpression | TaggedTemplateExpression | Decorator | JsxOpeningLikeElement;
- export interface AsExpression extends Expression {
- kind: SyntaxKind.AsExpression;
- expression: Expression;
- type: TypeNode;
- }
- export interface TypeAssertion extends UnaryExpression {
- kind: SyntaxKind.TypeAssertionExpression;
- type: TypeNode;
- expression: UnaryExpression;
- }
- export type AssertionExpression = TypeAssertion | AsExpression;
- export interface NonNullExpression extends LeftHandSideExpression {
- kind: SyntaxKind.NonNullExpression;
- expression: Expression;
- }
- export interface NonNullChain extends NonNullExpression {
- _optionalChainBrand: any;
- }
- export interface MetaProperty extends PrimaryExpression {
- kind: SyntaxKind.MetaProperty;
- keywordToken: SyntaxKind.NewKeyword | SyntaxKind.ImportKeyword;
- name: Identifier;
- }
- export interface JsxElement extends PrimaryExpression {
- kind: SyntaxKind.JsxElement;
- openingElement: JsxOpeningElement;
- children: NodeArray<JsxChild>;
- closingElement: JsxClosingElement;
- }
- export type JsxOpeningLikeElement = JsxSelfClosingElement | JsxOpeningElement;
- export type JsxAttributeLike = JsxAttribute | JsxSpreadAttribute;
- export type JsxTagNameExpression = Identifier | ThisExpression | JsxTagNamePropertyAccess;
- export interface JsxTagNamePropertyAccess extends PropertyAccessExpression {
- expression: JsxTagNameExpression;
- }
- export interface JsxAttributes extends ObjectLiteralExpressionBase<JsxAttributeLike> {
- kind: SyntaxKind.JsxAttributes;
- parent: JsxOpeningLikeElement;
- }
- export interface JsxOpeningElement extends Expression {
- kind: SyntaxKind.JsxOpeningElement;
- parent: JsxElement;
- tagName: JsxTagNameExpression;
- typeArguments?: NodeArray<TypeNode>;
- attributes: JsxAttributes;
- }
- export interface JsxSelfClosingElement extends PrimaryExpression {
- kind: SyntaxKind.JsxSelfClosingElement;
- tagName: JsxTagNameExpression;
- typeArguments?: NodeArray<TypeNode>;
- attributes: JsxAttributes;
- }
- export interface JsxFragment extends PrimaryExpression {
- kind: SyntaxKind.JsxFragment;
- openingFragment: JsxOpeningFragment;
- children: NodeArray<JsxChild>;
- closingFragment: JsxClosingFragment;
- }
- export interface JsxOpeningFragment extends Expression {
- kind: SyntaxKind.JsxOpeningFragment;
- parent: JsxFragment;
- }
- export interface JsxClosingFragment extends Expression {
- kind: SyntaxKind.JsxClosingFragment;
- parent: JsxFragment;
- }
- export interface JsxAttribute extends ObjectLiteralElement {
- kind: SyntaxKind.JsxAttribute;
- parent: JsxAttributes;
- name: Identifier;
- initializer?: StringLiteral | JsxExpression;
- }
- export interface JsxSpreadAttribute extends ObjectLiteralElement {
- kind: SyntaxKind.JsxSpreadAttribute;
- parent: JsxAttributes;
- expression: Expression;
- }
- export interface JsxClosingElement extends Node {
- kind: SyntaxKind.JsxClosingElement;
- parent: JsxElement;
- tagName: JsxTagNameExpression;
- }
- export interface JsxExpression extends Expression {
- kind: SyntaxKind.JsxExpression;
- parent: JsxElement | JsxAttributeLike;
- dotDotDotToken?: Token<SyntaxKind.DotDotDotToken>;
- expression?: Expression;
- }
- export interface JsxText extends LiteralLikeNode {
- kind: SyntaxKind.JsxText;
- containsOnlyTriviaWhiteSpaces: boolean;
- parent: JsxElement;
- }
- export type JsxChild = JsxText | JsxExpression | JsxElement | JsxSelfClosingElement | JsxFragment;
- export interface Statement extends Node {
- _statementBrand: any;
- }
- export interface NotEmittedStatement extends Statement {
- kind: SyntaxKind.NotEmittedStatement;
- }
- /**
- * A list of comma-separated expressions. This node is only created by transformations.
- */
- export interface CommaListExpression extends Expression {
- kind: SyntaxKind.CommaListExpression;
- elements: NodeArray<Expression>;
- }
- export interface EmptyStatement extends Statement {
- kind: SyntaxKind.EmptyStatement;
- }
- export interface DebuggerStatement extends Statement {
- kind: SyntaxKind.DebuggerStatement;
- }
- export interface MissingDeclaration extends DeclarationStatement {
- kind: SyntaxKind.MissingDeclaration;
- name?: Identifier;
- }
- export type BlockLike = SourceFile | Block | ModuleBlock | CaseOrDefaultClause;
- export interface Block extends Statement {
- kind: SyntaxKind.Block;
- statements: NodeArray<Statement>;
- }
- export interface VariableStatement extends Statement, JSDocContainer {
- kind: SyntaxKind.VariableStatement;
- declarationList: VariableDeclarationList;
- }
- export interface ExpressionStatement extends Statement, JSDocContainer {
- kind: SyntaxKind.ExpressionStatement;
- expression: Expression;
- }
- export interface IfStatement extends Statement {
- kind: SyntaxKind.IfStatement;
- expression: Expression;
- thenStatement: Statement;
- elseStatement?: Statement;
- }
- export interface IterationStatement extends Statement {
- statement: Statement;
- }
- export interface DoStatement extends IterationStatement {
- kind: SyntaxKind.DoStatement;
- expression: Expression;
- }
- export interface WhileStatement extends IterationStatement {
- kind: SyntaxKind.WhileStatement;
- expression: Expression;
- }
- export type ForInitializer = VariableDeclarationList | Expression;
- export interface ForStatement extends IterationStatement {
- kind: SyntaxKind.ForStatement;
- initializer?: ForInitializer;
- condition?: Expression;
- incrementor?: Expression;
- }
- export type ForInOrOfStatement = ForInStatement | ForOfStatement;
- export interface ForInStatement extends IterationStatement {
- kind: SyntaxKind.ForInStatement;
- initializer: ForInitializer;
- expression: Expression;
- }
- export interface ForOfStatement extends IterationStatement {
- kind: SyntaxKind.ForOfStatement;
- awaitModifier?: AwaitKeywordToken;
- initializer: ForInitializer;
- expression: Expression;
- }
- export interface BreakStatement extends Statement {
- kind: SyntaxKind.BreakStatement;
- label?: Identifier;
- }
- export interface ContinueStatement extends Statement {
- kind: SyntaxKind.ContinueStatement;
- label?: Identifier;
- }
- export type BreakOrContinueStatement = BreakStatement | ContinueStatement;
- export interface ReturnStatement extends Statement {
- kind: SyntaxKind.ReturnStatement;
- expression?: Expression;
- }
- export interface WithStatement extends Statement {
- kind: SyntaxKind.WithStatement;
- expression: Expression;
- statement: Statement;
- }
- export interface SwitchStatement extends Statement {
- kind: SyntaxKind.SwitchStatement;
- expression: Expression;
- caseBlock: CaseBlock;
- possiblyExhaustive?: boolean;
- }
- export interface CaseBlock extends Node {
- kind: SyntaxKind.CaseBlock;
- parent: SwitchStatement;
- clauses: NodeArray<CaseOrDefaultClause>;
- }
- export interface CaseClause extends Node {
- kind: SyntaxKind.CaseClause;
- parent: CaseBlock;
- expression: Expression;
- statements: NodeArray<Statement>;
- }
- export interface DefaultClause extends Node {
- kind: SyntaxKind.DefaultClause;
- parent: CaseBlock;
- statements: NodeArray<Statement>;
- }
- export type CaseOrDefaultClause = CaseClause | DefaultClause;
- export interface LabeledStatement extends Statement, JSDocContainer {
- kind: SyntaxKind.LabeledStatement;
- label: Identifier;
- statement: Statement;
- }
- export interface ThrowStatement extends Statement {
- kind: SyntaxKind.ThrowStatement;
- expression?: Expression;
- }
- export interface TryStatement extends Statement {
- kind: SyntaxKind.TryStatement;
- tryBlock: Block;
- catchClause?: CatchClause;
- finallyBlock?: Block;
- }
- export interface CatchClause extends Node {
- kind: SyntaxKind.CatchClause;
- parent: TryStatement;
- variableDeclaration?: VariableDeclaration;
- 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 {
- kind: SyntaxKind.ClassDeclaration | SyntaxKind.ClassExpression;
- name?: Identifier;
- typeParameters?: NodeArray<TypeParameterDeclaration>;
- heritageClauses?: NodeArray<HeritageClause>;
- members: NodeArray<ClassElement>;
- }
- export interface ClassDeclaration extends ClassLikeDeclarationBase, DeclarationStatement {
- kind: SyntaxKind.ClassDeclaration;
- /** May be undefined in `export default class { ... }`. */
- name?: Identifier;
- }
- export interface ClassExpression extends ClassLikeDeclarationBase, PrimaryExpression {
- kind: SyntaxKind.ClassExpression;
- }
- export type ClassLikeDeclaration = ClassDeclaration | ClassExpression;
- export interface ClassElement extends NamedDeclaration {
- _classElementBrand: any;
- name?: PropertyName;
- }
- export interface TypeElement extends NamedDeclaration {
- _typeElementBrand: any;
- name?: PropertyName;
- questionToken?: QuestionToken;
- }
- export interface InterfaceDeclaration extends DeclarationStatement, JSDocContainer {
- kind: SyntaxKind.InterfaceDeclaration;
- name: Identifier;
- typeParameters?: NodeArray<TypeParameterDeclaration>;
- heritageClauses?: NodeArray<HeritageClause>;
- members: NodeArray<TypeElement>;
- }
- export interface HeritageClause extends Node {
- kind: SyntaxKind.HeritageClause;
- parent: InterfaceDeclaration | ClassLikeDeclaration;
- token: SyntaxKind.ExtendsKeyword | SyntaxKind.ImplementsKeyword;
- types: NodeArray<ExpressionWithTypeArguments>;
- }
- export interface TypeAliasDeclaration extends DeclarationStatement, JSDocContainer {
- kind: SyntaxKind.TypeAliasDeclaration;
- name: Identifier;
- typeParameters?: NodeArray<TypeParameterDeclaration>;
- type: TypeNode;
- }
- export interface EnumMember extends NamedDeclaration, JSDocContainer {
- kind: SyntaxKind.EnumMember;
- parent: EnumDeclaration;
- name: PropertyName;
- initializer?: Expression;
- }
- export interface EnumDeclaration extends DeclarationStatement, JSDocContainer {
- kind: SyntaxKind.EnumDeclaration;
- name: Identifier;
- members: NodeArray<EnumMember>;
- }
- export type ModuleName = Identifier | StringLiteral;
- export type ModuleBody = NamespaceBody | JSDocNamespaceBody;
- export interface ModuleDeclaration extends DeclarationStatement, JSDocContainer {
- kind: SyntaxKind.ModuleDeclaration;
- parent: ModuleBody | SourceFile;
- name: ModuleName;
- body?: ModuleBody | JSDocNamespaceDeclaration;
- }
- export type NamespaceBody = ModuleBlock | NamespaceDeclaration;
- export interface NamespaceDeclaration extends ModuleDeclaration {
- name: Identifier;
- body: NamespaceBody;
- }
- export type JSDocNamespaceBody = Identifier | JSDocNamespaceDeclaration;
- export interface JSDocNamespaceDeclaration extends ModuleDeclaration {
- name: Identifier;
- body?: JSDocNamespaceBody;
- }
- export interface ModuleBlock extends Node, Statement {
- kind: SyntaxKind.ModuleBlock;
- parent: ModuleDeclaration;
- statements: NodeArray<Statement>;
- }
- export type ModuleReference = EntityName | ExternalModuleReference;
- /**
- * One of:
- * - import x = require("mod");
- * - import x = M.x;
- */
- export interface ImportEqualsDeclaration extends DeclarationStatement, JSDocContainer {
- kind: SyntaxKind.ImportEqualsDeclaration;
- parent: SourceFile | ModuleBlock;
- name: Identifier;
- moduleReference: ModuleReference;
- }
- export interface ExternalModuleReference extends Node {
- kind: SyntaxKind.ExternalModuleReference;
- parent: ImportEqualsDeclaration;
- expression: Expression;
- }
- export interface ImportDeclaration extends Statement {
- kind: SyntaxKind.ImportDeclaration;
- parent: SourceFile | ModuleBlock;
- importClause?: ImportClause;
- /** If this is not a StringLiteral it will be a grammar error. */
- moduleSpecifier: Expression;
- }
- export type NamedImportBindings = NamespaceImport | NamedImports;
- export type NamedExportBindings = NamespaceExport | NamedExports;
- export interface ImportClause extends NamedDeclaration {
- kind: SyntaxKind.ImportClause;
- parent: ImportDeclaration;
- isTypeOnly: boolean;
- name?: Identifier;
- namedBindings?: NamedImportBindings;
- }
- export interface NamespaceImport extends NamedDeclaration {
- kind: SyntaxKind.NamespaceImport;
- parent: ImportClause;
- name: Identifier;
- }
- export interface NamespaceExport extends NamedDeclaration {
- kind: SyntaxKind.NamespaceExport;
- parent: ExportDeclaration;
- name: Identifier;
- }
- export interface NamespaceExportDeclaration extends DeclarationStatement {
- kind: SyntaxKind.NamespaceExportDeclaration;
- name: Identifier;
- }
- export interface ExportDeclaration extends DeclarationStatement, JSDocContainer {
- kind: SyntaxKind.ExportDeclaration;
- parent: SourceFile | ModuleBlock;
- isTypeOnly: boolean;
- /** Will not be assigned in the case of `export * from "foo";` */
- exportClause?: NamedExportBindings;
- /** If this is not a StringLiteral it will be a grammar error. */
- moduleSpecifier?: Expression;
- }
- export interface NamedImports extends Node {
- kind: SyntaxKind.NamedImports;
- parent: ImportClause;
- elements: NodeArray<ImportSpecifier>;
- }
- export interface NamedExports extends Node {
- kind: SyntaxKind.NamedExports;
- parent: ExportDeclaration;
- elements: NodeArray<ExportSpecifier>;
- }
- export type NamedImportsOrExports = NamedImports | NamedExports;
- export interface ImportSpecifier extends NamedDeclaration {
- kind: SyntaxKind.ImportSpecifier;
- parent: NamedImports;
- propertyName?: Identifier;
- name: Identifier;
- }
- export interface ExportSpecifier extends NamedDeclaration {
- kind: SyntaxKind.ExportSpecifier;
- parent: NamedExports;
- propertyName?: Identifier;
- 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 {
- kind: SyntaxKind.ExportAssignment;
- parent: SourceFile;
- isExportEquals?: boolean;
- 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;
- }
- export interface JSDocTypeExpression extends TypeNode {
- kind: SyntaxKind.JSDocTypeExpression;
- type: TypeNode;
- }
- export interface JSDocType extends TypeNode {
- _jsDocTypeBrand: any;
- }
- export interface JSDocAllType extends JSDocType {
- kind: SyntaxKind.JSDocAllType;
- }
- export interface JSDocUnknownType extends JSDocType {
- kind: SyntaxKind.JSDocUnknownType;
- }
- export interface JSDocNonNullableType extends JSDocType {
- kind: SyntaxKind.JSDocNonNullableType;
- type: TypeNode;
- }
- export interface JSDocNullableType extends JSDocType {
- kind: SyntaxKind.JSDocNullableType;
- type: TypeNode;
- }
- export interface JSDocOptionalType extends JSDocType {
- kind: SyntaxKind.JSDocOptionalType;
- type: TypeNode;
- }
- export interface JSDocFunctionType extends JSDocType, SignatureDeclarationBase {
- kind: SyntaxKind.JSDocFunctionType;
- }
- export interface JSDocVariadicType extends JSDocType {
- kind: SyntaxKind.JSDocVariadicType;
- type: TypeNode;
- }
- export interface JSDocNamepathType extends JSDocType {
- kind: SyntaxKind.JSDocNamepathType;
- type: TypeNode;
- }
- export type JSDocTypeReferencingNode = JSDocVariadicType | JSDocOptionalType | JSDocNullableType | JSDocNonNullableType;
- export interface JSDoc extends Node {
- kind: SyntaxKind.JSDocComment;
- parent: HasJSDoc;
- tags?: NodeArray<JSDocTag>;
- comment?: string;
- }
- export interface JSDocTag extends Node {
- parent: JSDoc | JSDocTypeLiteral;
- tagName: Identifier;
- comment?: string;
- }
- export interface JSDocUnknownTag extends JSDocTag {
- kind: SyntaxKind.JSDocTag;
- }
- /**
- * Note that `@extends` is a synonym of `@augments`.
- * Both tags are represented by this interface.
- */
- export interface JSDocAugmentsTag extends JSDocTag {
- kind: SyntaxKind.JSDocAugmentsTag;
- class: ExpressionWithTypeArguments & {
- expression: Identifier | PropertyAccessEntityNameExpression;
- };
- }
- export interface JSDocImplementsTag extends JSDocTag {
- kind: SyntaxKind.JSDocImplementsTag;
- class: ExpressionWithTypeArguments & {
- expression: Identifier | PropertyAccessEntityNameExpression;
- };
- }
- export interface JSDocAuthorTag extends JSDocTag {
- kind: SyntaxKind.JSDocAuthorTag;
- }
- export interface JSDocClassTag extends JSDocTag {
- kind: SyntaxKind.JSDocClassTag;
- }
- export interface JSDocPublicTag extends JSDocTag {
- kind: SyntaxKind.JSDocPublicTag;
- }
- export interface JSDocPrivateTag extends JSDocTag {
- kind: SyntaxKind.JSDocPrivateTag;
- }
- export interface JSDocProtectedTag extends JSDocTag {
- kind: SyntaxKind.JSDocProtectedTag;
- }
- export interface JSDocReadonlyTag extends JSDocTag {
- kind: SyntaxKind.JSDocReadonlyTag;
- }
- export interface JSDocEnumTag extends JSDocTag, Declaration {
- parent: JSDoc;
- kind: SyntaxKind.JSDocEnumTag;
- typeExpression?: JSDocTypeExpression;
- }
- export interface JSDocThisTag extends JSDocTag {
- kind: SyntaxKind.JSDocThisTag;
- typeExpression?: JSDocTypeExpression;
- }
- export interface JSDocTemplateTag extends JSDocTag {
- kind: SyntaxKind.JSDocTemplateTag;
- constraint: JSDocTypeExpression | undefined;
- typeParameters: NodeArray<TypeParameterDeclaration>;
- }
- export interface JSDocReturnTag extends JSDocTag {
- kind: SyntaxKind.JSDocReturnTag;
- typeExpression?: JSDocTypeExpression;
- }
- export interface JSDocTypeTag extends JSDocTag {
- kind: SyntaxKind.JSDocTypeTag;
- typeExpression: JSDocTypeExpression;
- }
- export interface JSDocTypedefTag extends JSDocTag, NamedDeclaration {
- parent: JSDoc;
- kind: SyntaxKind.JSDocTypedefTag;
- fullName?: JSDocNamespaceDeclaration | Identifier;
- name?: Identifier;
- typeExpression?: JSDocTypeExpression | JSDocTypeLiteral;
- }
- export interface JSDocCallbackTag extends JSDocTag, NamedDeclaration {
- parent: JSDoc;
- kind: SyntaxKind.JSDocCallbackTag;
- fullName?: JSDocNamespaceDeclaration | Identifier;
- name?: Identifier;
- typeExpression: JSDocSignature;
- }
- export interface JSDocSignature extends JSDocType, Declaration {
- kind: SyntaxKind.JSDocSignature;
- typeParameters?: readonly JSDocTemplateTag[];
- parameters: readonly JSDocParameterTag[];
- type: JSDocReturnTag | undefined;
- }
- export interface JSDocPropertyLikeTag extends JSDocTag, Declaration {
- parent: JSDoc;
- name: EntityName;
- typeExpression?: JSDocTypeExpression;
- /** Whether the property name came before the type -- non-standard for JSDoc, but Typescript-like */
- isNameFirst: boolean;
- isBracketed: boolean;
- }
- export interface JSDocPropertyTag extends JSDocPropertyLikeTag {
- kind: SyntaxKind.JSDocPropertyTag;
- }
- export interface JSDocParameterTag extends JSDocPropertyLikeTag {
- kind: SyntaxKind.JSDocParameterTag;
- }
- export interface JSDocTypeLiteral extends JSDocType {
- kind: SyntaxKind.JSDocTypeLiteral;
- jsDocPropertyTags?: readonly JSDocPropertyLikeTag[];
- /** If true, then this type literal represents an *array* of its type. */
- 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 = AfterFinallyFlow | PreFinallyFlow | FlowStart | FlowLabel | FlowAssignment | FlowCall | FlowCondition | FlowSwitchClause | FlowArrayMutation;
- export interface FlowNodeBase {
- flags: FlowFlags;
- id?: number;
- }
- export interface FlowLock {
- locked?: boolean;
- }
- export interface AfterFinallyFlow extends FlowNodeBase, FlowLock {
- antecedent: FlowNode;
- }
- export interface PreFinallyFlow extends FlowNodeBase {
- antecedent: FlowNode;
- lock: FlowLock;
- }
- 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 {
- kind: SyntaxKind.SourceFile;
- statements: NodeArray<Statement>;
- endOfFileToken: Token<SyntaxKind.EndOfFileToken>;
- 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
- *
- * /// <reference no-default-lib="true"/>
- *
- * 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 {
- kind: SyntaxKind.Bundle;
- prepends: readonly (InputFiles | UnparsedSource)[];
- sourceFiles: readonly SourceFile[];
- }
- export interface InputFiles extends Node {
- kind: SyntaxKind.InputFiles;
- javascriptPath?: string;
- javascriptText: string;
- javascriptMapPath?: string;
- javascriptMapText?: string;
- declarationPath?: string;
- declarationText: string;
- declarationMapPath?: string;
- declarationMapText?: string;
- }
- export interface UnparsedSource extends Node {
- kind: SyntaxKind.UnparsedSource;
- fileName: string;
- text: string;
- prologues: readonly UnparsedPrologue[];
- helpers: readonly UnscopedEmitHelper[] | undefined;
- referencedFiles: readonly FileReference[];
- typeReferenceDirectives: readonly string[] | undefined;
- libReferenceDirectives: readonly FileReference[];
- hasNoDefaultLib?: boolean;
- sourceMapPath?: string;
- sourceMapText?: string;
- syntheticReferences?: readonly UnparsedSyntheticReference[];
- texts: readonly UnparsedSourceText[];
- }
- export type UnparsedSourceText = UnparsedPrepend | UnparsedTextLike;
- export type UnparsedNode = UnparsedPrologue | UnparsedSourceText | UnparsedSyntheticReference;
- export interface UnparsedSection extends Node {
- kind: SyntaxKind;
- data?: string;
- parent: UnparsedSource;
- }
- export interface UnparsedPrologue extends UnparsedSection {
- kind: SyntaxKind.UnparsedPrologue;
- data: string;
- parent: UnparsedSource;
- }
- export interface UnparsedPrepend extends UnparsedSection {
- kind: SyntaxKind.UnparsedPrepend;
- data: string;
- parent: UnparsedSource;
- texts: readonly UnparsedTextLike[];
- }
- export interface UnparsedTextLike extends UnparsedSection {
- kind: SyntaxKind.UnparsedText | SyntaxKind.UnparsedInternalText;
- parent: UnparsedSource;
- }
- export interface UnparsedSyntheticReference extends UnparsedSection {
- kind: SyntaxKind.UnparsedSyntheticReference;
- parent: UnparsedSource;
- }
- export interface JsonSourceFile extends SourceFile {
- statements: NodeArray<JsonObjectExpressionStatement>;
- }
- export interface TsConfigSourceFile extends JsonSourceFile {
- extendedSourceFiles?: string[];
- }
- export interface JsonMinusNumericLiteral extends PrefixUnaryExpression {
- kind: SyntaxKind.PrefixUnaryExpression;
- operator: SyntaxKind.MinusToken;
- operand: NumericLiteral;
- }
- export interface JsonObjectExpressionStatement extends ExpressionStatement {
- expression: ObjectLiteralExpression | ArrayLiteralExpression | JsonMinusNumericLiteral | NumericLiteral | StringLiteral | BooleanLiteral | NullLiteral;
- }
- 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;
- 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<SourceFile> | CustomTransformerFactory)[];
- /** Custom transformers to evaluate after built-in .js transformations. */
- after?: (TransformerFactory<SourceFile> | CustomTransformerFactory)[];
- /** Custom transformers to evaluate after built-in .d.ts transformations. */
- afterDeclarations?: (TransformerFactory<Bundle | SourceFile> | 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, flags?: NodeBuilderFlags): TypeNode | undefined;
- /** Note that the resulting nodes cannot be checked. */
- signatureToSignatureDeclaration(signature: Signature, kind: SyntaxKind, enclosingDeclaration?: Node, flags?: NodeBuilderFlags): (SignatureDeclaration & {
- typeArguments?: NodeArray<TypeNode>;
- }) | undefined;
- /** Note that the resulting nodes cannot be checked. */
- indexInfoToIndexSignatureDeclaration(indexInfo: IndexInfo, kind: IndexKind, enclosingDeclaration?: Node, flags?: NodeBuilderFlags): IndexSignatureDeclaration | undefined;
- /** Note that the resulting nodes cannot be checked. */
- symbolToEntityName(symbol: Symbol, meaning: SymbolFlags, enclosingDeclaration?: Node, flags?: NodeBuilderFlags): EntityName | undefined;
- /** Note that the resulting nodes cannot be checked. */
- symbolToExpression(symbol: Symbol, meaning: SymbolFlags, enclosingDeclaration?: Node, flags?: NodeBuilderFlags): Expression | undefined;
- /** Note that the resulting nodes cannot be checked. */
- symbolToTypeParameterDeclarations(symbol: Symbol, enclosingDeclaration?: Node, flags?: NodeBuilderFlags): NodeArray<TypeParameterDeclaration> | undefined;
- /** Note that the resulting nodes cannot be checked. */
- symbolToParameterDeclaration(symbol: Symbol, enclosingDeclaration?: Node, flags?: NodeBuilderFlags): ParameterDeclaration | undefined;
- /** Note that the resulting nodes cannot be checked. */
- typeParameterToDeclaration(parameter: TypeParameter, enclosingDeclaration?: Node, flags?: NodeBuilderFlags): 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): 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[];
- 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<T>(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,
- 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<T> {
- get(key: __String): T | undefined;
- has(key: __String): boolean;
- forEach(action: (value: T, key: __String) => void): void;
- readonly size: number;
- keys(): Iterator<__String>;
- values(): Iterator<T>;
- entries(): Iterator<[__String, T]>;
- }
- /** Map where keys are `__String`s. */
- export interface UnderscoreEscapedMap<T> extends ReadonlyUnderscoreEscapedMap<T> {
- set(key: __String, value: T): this;
- delete(key: __String): boolean;
- clear(): void;
- }
- /** SymbolTable based on ES6 Map interface. */
- export type SymbolTable = UnderscoreEscapedMap<Symbol>;
- 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,
- Literal = 2944,
- Unit = 109440,
- StringOrNumberLiteral = 384,
- PossiblyFalsy = 117724,
- StringLike = 132,
- NumberLike = 296,
- BigIntLike = 2112,
- BooleanLike = 528,
- EnumLike = 1056,
- ESSymbolLike = 12288,
- VoidLike = 49152,
- UnionOrIntersection = 3145728,
- StructuredType = 3670016,
- TypeVariable = 8650752,
- InstantiableNonPrimitive = 58982400,
- InstantiablePrimitive = 4194304,
- Instantiable = 63176704,
- StructuredOrInstantiable = 66846720,
- Narrowable = 133970943,
- NotUnionOrUnit = 67637251,
- }
- 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 interface TupleType extends GenericType {
- minLength: number;
- hasRestElement: boolean;
- readonly: boolean;
- associatedNames?: __String[];
- }
- 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;
- trueType: Type;
- falseType: Type;
- isDistributive: boolean;
- inferTypeParameters?: TypeParameter[];
- outerTypeParameters?: TypeParameter[];
- instantiations?: Map<Type>;
- aliasSymbol?: Symbol;
- aliasTypeArguments?: Type[];
- }
- export interface ConditionalType extends InstantiableType {
- root: ConditionalRoot;
- checkType: Type;
- extendsType: Type;
- resolvedTrueType: Type;
- resolvedFalseType: 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,
- HomomorphicMappedType = 2,
- PartialHomomorphicMappedType = 4,
- MappedTypeConstraint = 8,
- ContravariantConditional = 16,
- ReturnType = 32,
- LiteralKeyof = 64,
- NoConstraints = 128,
- AlwaysStrict = 256,
- MaxValue = 512,
- PriorityImpliesCombination = 104,
- 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?: {};
- }
- /**
- * 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?: {};
- 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<string[]> | 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;
- 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;
- out?: string;
- outDir?: string;
- outFile?: string;
- paths?: MapLike<string[]>;
- preserveConstEnums?: boolean;
- preserveSymlinks?: boolean;
- project?: string;
- reactNamespace?: string;
- jsxFactory?: 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[];
- [option: string]: string[] | boolean | 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
- }
- 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<WatchDirectoryFlags>;
- compileOnSave?: boolean;
- }
- export enum WatchDirectoryFlags {
- None = 0,
- Recursive = 1
- }
- export interface ExpandResult {
- fileNames: string[];
- wildcardDirectories: MapLike<WatchDirectoryFlags>;
- }
- 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 interface TransformationContext {
- /** 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;
- /** 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<T extends Node> {
- /** 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<T extends Node> = (context: TransformationContext) => Transformer<T>;
- /**
- * A function that transforms a node.
- */
- export type Transformer<T extends Node> = (node: T) => T;
- /**
- * A function that accepts and possibly transforms a node.
- */
- export type Visitor = (node: Node) => VisitResult<Node>;
- export type VisitResult<T extends Node> = 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<T extends Node>(format: ListFormat, list: NodeArray<T>, 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 {
- _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,
- TupleTypeElements = 528,
- 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;
- }
- /** 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;
- 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<T>(callback: () => T): T;
- scanRange<T>(start: number, length: number, callback: () => T): T;
- tryScan<T>(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<U>(text: string, pos: number, cb: (pos: number, end: number, kind: CommentKind, hasTrailingNewLine: boolean) => U): U | undefined;
- function forEachLeadingCommentRange<T, U>(text: string, pos: number, cb: (pos: number, end: number, kind: CommentKind, hasTrailingNewLine: boolean, state: T) => U, state: T): U | undefined;
- function forEachTrailingCommentRange<U>(text: string, pos: number, cb: (pos: number, end: number, kind: CommentKind, hasTrailingNewLine: boolean) => U): U | undefined;
- function forEachTrailingCommentRange<T, U>(text: string, pos: number, cb: (pos: number, end: number, kind: CommentKind, hasTrailingNewLine: boolean, state: T) => U, state: T): U | undefined;
- function reduceEachLeadingCommentRange<T, U>(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<T, U>(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<T extends Diagnostic>(diagnostics: readonly T[]): SortedReadonlyArray<T>;
- 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<Diagnostic>): void;
- function getOriginalNode(node: Node): Node;
- function getOriginalNode<T extends Node>(node: Node, nodeTest: (node: Node) => node is T): T;
- function getOriginalNode(node: Node | undefined): Node | undefined;
- function getOriginalNode<T extends Node>(node: Node | undefined, nodeTest: (node: Node | undefined) => node is T): T | 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): Node;
- /**
- * 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<T extends Node>(node: Node | 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 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<T extends JSDocTag>(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 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 isIdentifierOrPrivateIdentifier(node: Node): node is Identifier | 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 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 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 isPropertyAccessChain(node: Node): node is PropertyAccessChain;
- function isElementAccessExpression(node: Node): node is ElementAccessExpression;
- function isElementAccessChain(node: Node): node is ElementAccessChain;
- function isCallExpression(node: Node): node is CallExpression;
- function isCallChain(node: Node): node is CallChain;
- function isOptionalChain(node: Node): node is PropertyAccessChain | ElementAccessChain | CallChain | NonNullChain;
- function isNullishCoalesce(node: Node): boolean;
- function isNewExpression(node: Node): node is NewExpression;
- function isTaggedTemplateExpression(node: Node): node is TaggedTemplateExpression;
- function isTypeAssertion(node: Node): node is TypeAssertion;
- function isConstTypeReference(node: Node): boolean;
- function isParenthesizedExpression(node: Node): node is ParenthesizedExpression;
- function skipPartiallyEmittedExpressions(node: Expression): Expression;
- function skipPartiallyEmittedExpressions(node: Node): Node;
- 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 isNonNullChain(node: Node): node is NonNullChain;
- function isMetaProperty(node: Node): node is MetaProperty;
- 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 isBreakOrContinueStatement(node: Node): node is BreakOrContinueStatement;
- 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 isNamedExportBindings(node: Node): node is NamedExportBindings;
- 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 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 isSourceFile(node: Node): node is SourceFile;
- function isBundle(node: Node): node is Bundle;
- function isUnparsedSource(node: Node): node is UnparsedSource;
- function isUnparsedPrepend(node: Node): node is UnparsedPrepend;
- function isUnparsedTextLike(node: Node): node is UnparsedTextLike;
- function isUnparsedNode(node: Node): node is UnparsedNode;
- function isJSDocTypeExpression(node: Node): node is JSDocTypeExpression;
- 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 isJSDoc(node: Node): node is JSDoc;
- function isJSDocAuthorTag(node: Node): node is JSDocAuthorTag;
- function isJSDocAugmentsTag(node: Node): node is JSDocAugmentsTag;
- function isJSDocImplementsTag(node: Node): node is JSDocImplementsTag;
- function isJSDocClassTag(node: Node): node is JSDocClassTag;
- 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 isJSDocEnumTag(node: Node): node is JSDocEnumTag;
- function isJSDocThisTag(node: Node): node is JSDocThisTag;
- function isJSDocParameterTag(node: Node): node is JSDocParameterTag;
- function isJSDocReturnTag(node: Node): node is JSDocReturnTag;
- function isJSDocTypeTag(node: Node): node is JSDocTypeTag;
- function isJSDocTemplateTag(node: Node): node is JSDocTemplateTag;
- function isJSDocTypedefTag(node: Node): node is JSDocTypedefTag;
- function isJSDocPropertyTag(node: Node): node is JSDocPropertyTag;
- function isJSDocPropertyLikeTag(node: Node): node is JSDocPropertyLikeTag;
- function isJSDocTypeLiteral(node: Node): node is JSDocTypeLiteral;
- function isJSDocCallbackTag(node: Node): node is JSDocCallbackTag;
- function isJSDocSignature(node: Node): node is JSDocSignature;
- /**
- * 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;
- type TemplateLiteralToken = NoSubstitutionTemplateLiteral | TemplateHead | TemplateMiddle | TemplateTail;
- 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 {
- export function createNode(kind: SyntaxKind, pos?: number, end?: number): Node;
- /**
- * 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<T>(node: Node, cbNode: (node: Node) => T | undefined, cbNodes?: (nodes: NodeArray<Node>) => 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<ExtendedConfigCacheEntry>, 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<Diagnostic>): 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<ExtendedConfigCacheEntry>, 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<ExtendedConfigCacheEntry>, 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<ResolvedModuleWithFailedLookupLocations>;
- }
- /**
- * 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 {
- function createNodeArray<T extends Node>(elements?: readonly T[], hasTrailingComma?: boolean): NodeArray<T>;
- /** If a node is passed, creates a string literal whose source text is read from a source node during emit. */
- function createLiteral(value: string | StringLiteral | NoSubstitutionTemplateLiteral | NumericLiteral | Identifier): StringLiteral;
- function createLiteral(value: number | PseudoBigInt): NumericLiteral;
- function createLiteral(value: boolean): BooleanLiteral;
- function createLiteral(value: string | number | PseudoBigInt | boolean): PrimaryExpression;
- function createNumericLiteral(value: string, numericLiteralFlags?: TokenFlags): NumericLiteral;
- function createBigIntLiteral(value: string): BigIntLiteral;
- function createStringLiteral(text: string): StringLiteral;
- function createRegularExpressionLiteral(text: string): RegularExpressionLiteral;
- function createIdentifier(text: string): Identifier;
- function updateIdentifier(node: Identifier): Identifier;
- /** Create a unique temporary variable. */
- function createTempVariable(recordTempVariable: ((node: Identifier) => void) | undefined): Identifier;
- /** Create a unique temporary variable for use in a loop. */
- function createLoopVariable(): Identifier;
- /** Create a unique name based on the supplied text. */
- function createUniqueName(text: string): Identifier;
- /** Create a unique name based on the supplied text. */
- function createOptimisticUniqueName(text: string): Identifier;
- /** Create a unique name based on the supplied text. This does not consider names injected by the transformer. */
- function createFileLevelUniqueName(text: string): Identifier;
- /** Create a unique name generated for a node. */
- function getGeneratedNameForNode(node: Node | undefined): Identifier;
- function createPrivateIdentifier(text: string): PrivateIdentifier;
- function createToken<TKind extends SyntaxKind>(token: TKind): Token<TKind>;
- function createSuper(): SuperExpression;
- function createThis(): ThisExpression & Token<SyntaxKind.ThisKeyword>;
- function createNull(): NullLiteral & Token<SyntaxKind.NullKeyword>;
- function createTrue(): BooleanLiteral & Token<SyntaxKind.TrueKeyword>;
- function createFalse(): BooleanLiteral & Token<SyntaxKind.FalseKeyword>;
- function createModifier<T extends Modifier["kind"]>(kind: T): Token<T>;
- function createModifiersFromModifierFlags(flags: ModifierFlags): Modifier[];
- function createQualifiedName(left: EntityName, right: string | Identifier): QualifiedName;
- function updateQualifiedName(node: QualifiedName, left: EntityName, right: Identifier): QualifiedName;
- function createComputedPropertyName(expression: Expression): ComputedPropertyName;
- function updateComputedPropertyName(node: ComputedPropertyName, expression: Expression): ComputedPropertyName;
- function createTypeParameterDeclaration(name: string | Identifier, constraint?: TypeNode, defaultType?: TypeNode): TypeParameterDeclaration;
- function updateTypeParameterDeclaration(node: TypeParameterDeclaration, name: Identifier, constraint: TypeNode | undefined, defaultType: TypeNode | undefined): TypeParameterDeclaration;
- function createParameter(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, dotDotDotToken: DotDotDotToken | undefined, name: string | BindingName, questionToken?: QuestionToken, type?: TypeNode, initializer?: Expression): ParameterDeclaration;
- function updateParameter(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;
- function createDecorator(expression: Expression): Decorator;
- function updateDecorator(node: Decorator, expression: Expression): Decorator;
- function createPropertySignature(modifiers: readonly Modifier[] | undefined, name: PropertyName | string, questionToken: QuestionToken | undefined, type: TypeNode | undefined, initializer: Expression | undefined): PropertySignature;
- function updatePropertySignature(node: PropertySignature, modifiers: readonly Modifier[] | undefined, name: PropertyName, questionToken: QuestionToken | undefined, type: TypeNode | undefined, initializer: Expression | undefined): PropertySignature;
- function createProperty(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | PropertyName, questionOrExclamationToken: QuestionToken | ExclamationToken | undefined, type: TypeNode | undefined, initializer: Expression | undefined): PropertyDeclaration;
- function updateProperty(node: PropertyDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | PropertyName, questionOrExclamationToken: QuestionToken | ExclamationToken | undefined, type: TypeNode | undefined, initializer: Expression | undefined): PropertyDeclaration;
- function createMethodSignature(typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, name: string | PropertyName, questionToken: QuestionToken | undefined): MethodSignature;
- function updateMethodSignature(node: MethodSignature, typeParameters: NodeArray<TypeParameterDeclaration> | undefined, parameters: NodeArray<ParameterDeclaration>, type: TypeNode | undefined, name: PropertyName, questionToken: QuestionToken | undefined): MethodSignature;
- function createMethod(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;
- function 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;
- function createConstructor(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, parameters: readonly ParameterDeclaration[], body: Block | undefined): ConstructorDeclaration;
- function updateConstructor(node: ConstructorDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, parameters: readonly ParameterDeclaration[], body: Block | undefined): ConstructorDeclaration;
- function createGetAccessor(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | PropertyName, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, body: Block | undefined): GetAccessorDeclaration;
- function updateGetAccessor(node: GetAccessorDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: PropertyName, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, body: Block | undefined): GetAccessorDeclaration;
- function createSetAccessor(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | PropertyName, parameters: readonly ParameterDeclaration[], body: Block | undefined): SetAccessorDeclaration;
- function updateSetAccessor(node: SetAccessorDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: PropertyName, parameters: readonly ParameterDeclaration[], body: Block | undefined): SetAccessorDeclaration;
- function createCallSignature(typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined): CallSignatureDeclaration;
- function updateCallSignature(node: CallSignatureDeclaration, typeParameters: NodeArray<TypeParameterDeclaration> | undefined, parameters: NodeArray<ParameterDeclaration>, type: TypeNode | undefined): CallSignatureDeclaration;
- function createConstructSignature(typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined): ConstructSignatureDeclaration;
- function updateConstructSignature(node: ConstructSignatureDeclaration, typeParameters: NodeArray<TypeParameterDeclaration> | undefined, parameters: NodeArray<ParameterDeclaration>, type: TypeNode | undefined): ConstructSignatureDeclaration;
- function createIndexSignature(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode): IndexSignatureDeclaration;
- function updateIndexSignature(node: IndexSignatureDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode): IndexSignatureDeclaration;
- function createKeywordTypeNode(kind: KeywordTypeNode["kind"]): KeywordTypeNode;
- function createTypePredicateNode(parameterName: Identifier | ThisTypeNode | string, type: TypeNode): TypePredicateNode;
- function createTypePredicateNodeWithModifier(assertsModifier: AssertsToken | undefined, parameterName: Identifier | ThisTypeNode | string, type: TypeNode | undefined): TypePredicateNode;
- function updateTypePredicateNode(node: TypePredicateNode, parameterName: Identifier | ThisTypeNode, type: TypeNode): TypePredicateNode;
- function updateTypePredicateNodeWithModifier(node: TypePredicateNode, assertsModifier: AssertsToken | undefined, parameterName: Identifier | ThisTypeNode, type: TypeNode | undefined): TypePredicateNode;
- function createTypeReferenceNode(typeName: string | EntityName, typeArguments: readonly TypeNode[] | undefined): TypeReferenceNode;
- function updateTypeReferenceNode(node: TypeReferenceNode, typeName: EntityName, typeArguments: NodeArray<TypeNode> | undefined): TypeReferenceNode;
- function createFunctionTypeNode(typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined): FunctionTypeNode;
- function updateFunctionTypeNode(node: FunctionTypeNode, typeParameters: NodeArray<TypeParameterDeclaration> | undefined, parameters: NodeArray<ParameterDeclaration>, type: TypeNode | undefined): FunctionTypeNode;
- function createConstructorTypeNode(typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined): ConstructorTypeNode;
- function updateConstructorTypeNode(node: ConstructorTypeNode, typeParameters: NodeArray<TypeParameterDeclaration> | undefined, parameters: NodeArray<ParameterDeclaration>, type: TypeNode | undefined): ConstructorTypeNode;
- function createTypeQueryNode(exprName: EntityName): TypeQueryNode;
- function updateTypeQueryNode(node: TypeQueryNode, exprName: EntityName): TypeQueryNode;
- function createTypeLiteralNode(members: readonly TypeElement[] | undefined): TypeLiteralNode;
- function updateTypeLiteralNode(node: TypeLiteralNode, members: NodeArray<TypeElement>): TypeLiteralNode;
- function createArrayTypeNode(elementType: TypeNode): ArrayTypeNode;
- function updateArrayTypeNode(node: ArrayTypeNode, elementType: TypeNode): ArrayTypeNode;
- function createTupleTypeNode(elementTypes: readonly TypeNode[]): TupleTypeNode;
- function updateTupleTypeNode(node: TupleTypeNode, elementTypes: readonly TypeNode[]): TupleTypeNode;
- function createOptionalTypeNode(type: TypeNode): OptionalTypeNode;
- function updateOptionalTypeNode(node: OptionalTypeNode, type: TypeNode): OptionalTypeNode;
- function createRestTypeNode(type: TypeNode): RestTypeNode;
- function updateRestTypeNode(node: RestTypeNode, type: TypeNode): RestTypeNode;
- function createUnionTypeNode(types: readonly TypeNode[]): UnionTypeNode;
- function updateUnionTypeNode(node: UnionTypeNode, types: NodeArray<TypeNode>): UnionTypeNode;
- function createIntersectionTypeNode(types: readonly TypeNode[]): IntersectionTypeNode;
- function updateIntersectionTypeNode(node: IntersectionTypeNode, types: NodeArray<TypeNode>): IntersectionTypeNode;
- function createUnionOrIntersectionTypeNode(kind: SyntaxKind.UnionType | SyntaxKind.IntersectionType, types: readonly TypeNode[]): UnionOrIntersectionTypeNode;
- function createConditionalTypeNode(checkType: TypeNode, extendsType: TypeNode, trueType: TypeNode, falseType: TypeNode): ConditionalTypeNode;
- function updateConditionalTypeNode(node: ConditionalTypeNode, checkType: TypeNode, extendsType: TypeNode, trueType: TypeNode, falseType: TypeNode): ConditionalTypeNode;
- function createInferTypeNode(typeParameter: TypeParameterDeclaration): InferTypeNode;
- function updateInferTypeNode(node: InferTypeNode, typeParameter: TypeParameterDeclaration): InferTypeNode;
- function createImportTypeNode(argument: TypeNode, qualifier?: EntityName, typeArguments?: readonly TypeNode[], isTypeOf?: boolean): ImportTypeNode;
- function updateImportTypeNode(node: ImportTypeNode, argument: TypeNode, qualifier?: EntityName, typeArguments?: readonly TypeNode[], isTypeOf?: boolean): ImportTypeNode;
- function createParenthesizedType(type: TypeNode): ParenthesizedTypeNode;
- function updateParenthesizedType(node: ParenthesizedTypeNode, type: TypeNode): ParenthesizedTypeNode;
- function createThisTypeNode(): ThisTypeNode;
- function createTypeOperatorNode(type: TypeNode): TypeOperatorNode;
- function createTypeOperatorNode(operator: SyntaxKind.KeyOfKeyword | SyntaxKind.UniqueKeyword | SyntaxKind.ReadonlyKeyword, type: TypeNode): TypeOperatorNode;
- function updateTypeOperatorNode(node: TypeOperatorNode, type: TypeNode): TypeOperatorNode;
- function createIndexedAccessTypeNode(objectType: TypeNode, indexType: TypeNode): IndexedAccessTypeNode;
- function updateIndexedAccessTypeNode(node: IndexedAccessTypeNode, objectType: TypeNode, indexType: TypeNode): IndexedAccessTypeNode;
- function createMappedTypeNode(readonlyToken: ReadonlyToken | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined): MappedTypeNode;
- function updateMappedTypeNode(node: MappedTypeNode, readonlyToken: ReadonlyToken | PlusToken | MinusToken | undefined, typeParameter: TypeParameterDeclaration, questionToken: QuestionToken | PlusToken | MinusToken | undefined, type: TypeNode | undefined): MappedTypeNode;
- function createLiteralTypeNode(literal: LiteralTypeNode["literal"]): LiteralTypeNode;
- function updateLiteralTypeNode(node: LiteralTypeNode, literal: LiteralTypeNode["literal"]): LiteralTypeNode;
- function createObjectBindingPattern(elements: readonly BindingElement[]): ObjectBindingPattern;
- function updateObjectBindingPattern(node: ObjectBindingPattern, elements: readonly BindingElement[]): ObjectBindingPattern;
- function createArrayBindingPattern(elements: readonly ArrayBindingElement[]): ArrayBindingPattern;
- function updateArrayBindingPattern(node: ArrayBindingPattern, elements: readonly ArrayBindingElement[]): ArrayBindingPattern;
- function createBindingElement(dotDotDotToken: DotDotDotToken | undefined, propertyName: string | PropertyName | undefined, name: string | BindingName, initializer?: Expression): BindingElement;
- function updateBindingElement(node: BindingElement, dotDotDotToken: DotDotDotToken | undefined, propertyName: PropertyName | undefined, name: BindingName, initializer: Expression | undefined): BindingElement;
- function createArrayLiteral(elements?: readonly Expression[], multiLine?: boolean): ArrayLiteralExpression;
- function updateArrayLiteral(node: ArrayLiteralExpression, elements: readonly Expression[]): ArrayLiteralExpression;
- function createObjectLiteral(properties?: readonly ObjectLiteralElementLike[], multiLine?: boolean): ObjectLiteralExpression;
- function updateObjectLiteral(node: ObjectLiteralExpression, properties: readonly ObjectLiteralElementLike[]): ObjectLiteralExpression;
- function createPropertyAccess(expression: Expression, name: string | Identifier | PrivateIdentifier): PropertyAccessExpression;
- function updatePropertyAccess(node: PropertyAccessExpression, expression: Expression, name: Identifier | PrivateIdentifier): PropertyAccessExpression;
- function createPropertyAccessChain(expression: Expression, questionDotToken: QuestionDotToken | undefined, name: string | Identifier): PropertyAccessChain;
- function updatePropertyAccessChain(node: PropertyAccessChain, expression: Expression, questionDotToken: QuestionDotToken | undefined, name: Identifier): PropertyAccessChain;
- function createElementAccess(expression: Expression, index: number | Expression): ElementAccessExpression;
- function updateElementAccess(node: ElementAccessExpression, expression: Expression, argumentExpression: Expression): ElementAccessExpression;
- function createElementAccessChain(expression: Expression, questionDotToken: QuestionDotToken | undefined, index: number | Expression): ElementAccessChain;
- function updateElementAccessChain(node: ElementAccessChain, expression: Expression, questionDotToken: QuestionDotToken | undefined, argumentExpression: Expression): ElementAccessChain;
- function createCall(expression: Expression, typeArguments: readonly TypeNode[] | undefined, argumentsArray: readonly Expression[] | undefined): CallExpression;
- function updateCall(node: CallExpression, expression: Expression, typeArguments: readonly TypeNode[] | undefined, argumentsArray: readonly Expression[]): CallExpression;
- function createCallChain(expression: Expression, questionDotToken: QuestionDotToken | undefined, typeArguments: readonly TypeNode[] | undefined, argumentsArray: readonly Expression[] | undefined): CallChain;
- function updateCallChain(node: CallChain, expression: Expression, questionDotToken: QuestionDotToken | undefined, typeArguments: readonly TypeNode[] | undefined, argumentsArray: readonly Expression[]): CallChain;
- function createNew(expression: Expression, typeArguments: readonly TypeNode[] | undefined, argumentsArray: readonly Expression[] | undefined): NewExpression;
- function updateNew(node: NewExpression, expression: Expression, typeArguments: readonly TypeNode[] | undefined, argumentsArray: readonly Expression[] | undefined): NewExpression;
- /** @deprecated */ function createTaggedTemplate(tag: Expression, template: TemplateLiteral): TaggedTemplateExpression;
- function createTaggedTemplate(tag: Expression, typeArguments: readonly TypeNode[] | undefined, template: TemplateLiteral): TaggedTemplateExpression;
- /** @deprecated */ function updateTaggedTemplate(node: TaggedTemplateExpression, tag: Expression, template: TemplateLiteral): TaggedTemplateExpression;
- function updateTaggedTemplate(node: TaggedTemplateExpression, tag: Expression, typeArguments: readonly TypeNode[] | undefined, template: TemplateLiteral): TaggedTemplateExpression;
- function createTypeAssertion(type: TypeNode, expression: Expression): TypeAssertion;
- function updateTypeAssertion(node: TypeAssertion, type: TypeNode, expression: Expression): TypeAssertion;
- function createParen(expression: Expression): ParenthesizedExpression;
- function updateParen(node: ParenthesizedExpression, expression: Expression): ParenthesizedExpression;
- function 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;
- function 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;
- function createArrowFunction(modifiers: readonly Modifier[] | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, equalsGreaterThanToken: EqualsGreaterThanToken | undefined, body: ConciseBody): ArrowFunction;
- function updateArrowFunction(node: ArrowFunction, modifiers: readonly Modifier[] | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, parameters: readonly ParameterDeclaration[], type: TypeNode | undefined, equalsGreaterThanToken: Token<SyntaxKind.EqualsGreaterThanToken>, body: ConciseBody): ArrowFunction;
- function createDelete(expression: Expression): DeleteExpression;
- function updateDelete(node: DeleteExpression, expression: Expression): DeleteExpression;
- function createTypeOf(expression: Expression): TypeOfExpression;
- function updateTypeOf(node: TypeOfExpression, expression: Expression): TypeOfExpression;
- function createVoid(expression: Expression): VoidExpression;
- function updateVoid(node: VoidExpression, expression: Expression): VoidExpression;
- function createAwait(expression: Expression): AwaitExpression;
- function updateAwait(node: AwaitExpression, expression: Expression): AwaitExpression;
- function createPrefix(operator: PrefixUnaryOperator, operand: Expression): PrefixUnaryExpression;
- function updatePrefix(node: PrefixUnaryExpression, operand: Expression): PrefixUnaryExpression;
- function createPostfix(operand: Expression, operator: PostfixUnaryOperator): PostfixUnaryExpression;
- function updatePostfix(node: PostfixUnaryExpression, operand: Expression): PostfixUnaryExpression;
- function createBinary(left: Expression, operator: BinaryOperator | BinaryOperatorToken, right: Expression): BinaryExpression;
- function updateBinary(node: BinaryExpression, left: Expression, right: Expression, operator?: BinaryOperator | BinaryOperatorToken): BinaryExpression;
- /** @deprecated */ function createConditional(condition: Expression, whenTrue: Expression, whenFalse: Expression): ConditionalExpression;
- function createConditional(condition: Expression, questionToken: QuestionToken, whenTrue: Expression, colonToken: ColonToken, whenFalse: Expression): ConditionalExpression;
- function updateConditional(node: ConditionalExpression, condition: Expression, questionToken: Token<SyntaxKind.QuestionToken>, whenTrue: Expression, colonToken: Token<SyntaxKind.ColonToken>, whenFalse: Expression): ConditionalExpression;
- function createTemplateExpression(head: TemplateHead, templateSpans: readonly TemplateSpan[]): TemplateExpression;
- function updateTemplateExpression(node: TemplateExpression, head: TemplateHead, templateSpans: readonly TemplateSpan[]): TemplateExpression;
- function createTemplateHead(text: string, rawText?: string): TemplateHead;
- function createTemplateMiddle(text: string, rawText?: string): TemplateMiddle;
- function createTemplateTail(text: string, rawText?: string): TemplateTail;
- function createNoSubstitutionTemplateLiteral(text: string, rawText?: string): NoSubstitutionTemplateLiteral;
- function createYield(expression?: Expression): YieldExpression;
- function createYield(asteriskToken: AsteriskToken | undefined, expression: Expression): YieldExpression;
- function updateYield(node: YieldExpression, asteriskToken: AsteriskToken | undefined, expression: Expression): YieldExpression;
- function createSpread(expression: Expression): SpreadElement;
- function updateSpread(node: SpreadElement, expression: Expression): SpreadElement;
- function createClassExpression(modifiers: readonly Modifier[] | undefined, name: string | Identifier | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, heritageClauses: readonly HeritageClause[] | undefined, members: readonly ClassElement[]): ClassExpression;
- function updateClassExpression(node: ClassExpression, modifiers: readonly Modifier[] | undefined, name: Identifier | undefined, typeParameters: readonly TypeParameterDeclaration[] | undefined, heritageClauses: readonly HeritageClause[] | undefined, members: readonly ClassElement[]): ClassExpression;
- function createOmittedExpression(): OmittedExpression;
- function createExpressionWithTypeArguments(typeArguments: readonly TypeNode[] | undefined, expression: Expression): ExpressionWithTypeArguments;
- function updateExpressionWithTypeArguments(node: ExpressionWithTypeArguments, typeArguments: readonly TypeNode[] | undefined, expression: Expression): ExpressionWithTypeArguments;
- function createAsExpression(expression: Expression, type: TypeNode): AsExpression;
- function updateAsExpression(node: AsExpression, expression: Expression, type: TypeNode): AsExpression;
- function createNonNullExpression(expression: Expression): NonNullExpression;
- function updateNonNullExpression(node: NonNullExpression, expression: Expression): NonNullExpression;
- function createNonNullChain(expression: Expression): NonNullChain;
- function updateNonNullChain(node: NonNullChain, expression: Expression): NonNullChain;
- function createMetaProperty(keywordToken: MetaProperty["keywordToken"], name: Identifier): MetaProperty;
- function updateMetaProperty(node: MetaProperty, name: Identifier): MetaProperty;
- function createTemplateSpan(expression: Expression, literal: TemplateMiddle | TemplateTail): TemplateSpan;
- function updateTemplateSpan(node: TemplateSpan, expression: Expression, literal: TemplateMiddle | TemplateTail): TemplateSpan;
- function createSemicolonClassElement(): SemicolonClassElement;
- function createBlock(statements: readonly Statement[], multiLine?: boolean): Block;
- function updateBlock(node: Block, statements: readonly Statement[]): Block;
- function createVariableStatement(modifiers: readonly Modifier[] | undefined, declarationList: VariableDeclarationList | readonly VariableDeclaration[]): VariableStatement;
- function updateVariableStatement(node: VariableStatement, modifiers: readonly Modifier[] | undefined, declarationList: VariableDeclarationList): VariableStatement;
- function createEmptyStatement(): EmptyStatement;
- function createExpressionStatement(expression: Expression): ExpressionStatement;
- function updateExpressionStatement(node: ExpressionStatement, expression: Expression): ExpressionStatement;
- /** @deprecated Use `createExpressionStatement` instead. */
- const createStatement: typeof createExpressionStatement;
- /** @deprecated Use `updateExpressionStatement` instead. */
- const updateStatement: typeof updateExpressionStatement;
- function createIf(expression: Expression, thenStatement: Statement, elseStatement?: Statement): IfStatement;
- function updateIf(node: IfStatement, expression: Expression, thenStatement: Statement, elseStatement: Statement | undefined): IfStatement;
- function createDo(statement: Statement, expression: Expression): DoStatement;
- function updateDo(node: DoStatement, statement: Statement, expression: Expression): DoStatement;
- function createWhile(expression: Expression, statement: Statement): WhileStatement;
- function updateWhile(node: WhileStatement, expression: Expression, statement: Statement): WhileStatement;
- function createFor(initializer: ForInitializer | undefined, condition: Expression | undefined, incrementor: Expression | undefined, statement: Statement): ForStatement;
- function updateFor(node: ForStatement, initializer: ForInitializer | undefined, condition: Expression | undefined, incrementor: Expression | undefined, statement: Statement): ForStatement;
- function createForIn(initializer: ForInitializer, expression: Expression, statement: Statement): ForInStatement;
- function updateForIn(node: ForInStatement, initializer: ForInitializer, expression: Expression, statement: Statement): ForInStatement;
- function createForOf(awaitModifier: AwaitKeywordToken | undefined, initializer: ForInitializer, expression: Expression, statement: Statement): ForOfStatement;
- function updateForOf(node: ForOfStatement, awaitModifier: AwaitKeywordToken | undefined, initializer: ForInitializer, expression: Expression, statement: Statement): ForOfStatement;
- function createContinue(label?: string | Identifier): ContinueStatement;
- function updateContinue(node: ContinueStatement, label: Identifier | undefined): ContinueStatement;
- function createBreak(label?: string | Identifier): BreakStatement;
- function updateBreak(node: BreakStatement, label: Identifier | undefined): BreakStatement;
- function createReturn(expression?: Expression): ReturnStatement;
- function updateReturn(node: ReturnStatement, expression: Expression | undefined): ReturnStatement;
- function createWith(expression: Expression, statement: Statement): WithStatement;
- function updateWith(node: WithStatement, expression: Expression, statement: Statement): WithStatement;
- function createSwitch(expression: Expression, caseBlock: CaseBlock): SwitchStatement;
- function updateSwitch(node: SwitchStatement, expression: Expression, caseBlock: CaseBlock): SwitchStatement;
- function createLabel(label: string | Identifier, statement: Statement): LabeledStatement;
- function updateLabel(node: LabeledStatement, label: Identifier, statement: Statement): LabeledStatement;
- function createThrow(expression: Expression): ThrowStatement;
- function updateThrow(node: ThrowStatement, expression: Expression): ThrowStatement;
- function createTry(tryBlock: Block, catchClause: CatchClause | undefined, finallyBlock: Block | undefined): TryStatement;
- function updateTry(node: TryStatement, tryBlock: Block, catchClause: CatchClause | undefined, finallyBlock: Block | undefined): TryStatement;
- function createDebuggerStatement(): DebuggerStatement;
- function createVariableDeclaration(name: string | BindingName, type?: TypeNode, initializer?: Expression): VariableDeclaration;
- function updateVariableDeclaration(node: VariableDeclaration, name: BindingName, type: TypeNode | undefined, initializer: Expression | undefined): VariableDeclaration;
- function createVariableDeclarationList(declarations: readonly VariableDeclaration[], flags?: NodeFlags): VariableDeclarationList;
- function updateVariableDeclarationList(node: VariableDeclarationList, declarations: readonly VariableDeclaration[]): VariableDeclarationList;
- function 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;
- function 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;
- function 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;
- function 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;
- function createInterfaceDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier, typeParameters: readonly TypeParameterDeclaration[] | undefined, heritageClauses: readonly HeritageClause[] | undefined, members: readonly TypeElement[]): InterfaceDeclaration;
- function 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;
- function createTypeAliasDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier, typeParameters: readonly TypeParameterDeclaration[] | undefined, type: TypeNode): TypeAliasDeclaration;
- function updateTypeAliasDeclaration(node: TypeAliasDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: Identifier, typeParameters: readonly TypeParameterDeclaration[] | undefined, type: TypeNode): TypeAliasDeclaration;
- function createEnumDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier, members: readonly EnumMember[]): EnumDeclaration;
- function updateEnumDeclaration(node: EnumDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: Identifier, members: readonly EnumMember[]): EnumDeclaration;
- function createModuleDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: ModuleName, body: ModuleBody | undefined, flags?: NodeFlags): ModuleDeclaration;
- function updateModuleDeclaration(node: ModuleDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: ModuleName, body: ModuleBody | undefined): ModuleDeclaration;
- function createModuleBlock(statements: readonly Statement[]): ModuleBlock;
- function updateModuleBlock(node: ModuleBlock, statements: readonly Statement[]): ModuleBlock;
- function createCaseBlock(clauses: readonly CaseOrDefaultClause[]): CaseBlock;
- function updateCaseBlock(node: CaseBlock, clauses: readonly CaseOrDefaultClause[]): CaseBlock;
- function createNamespaceExportDeclaration(name: string | Identifier): NamespaceExportDeclaration;
- function updateNamespaceExportDeclaration(node: NamespaceExportDeclaration, name: Identifier): NamespaceExportDeclaration;
- function createImportEqualsDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: string | Identifier, moduleReference: ModuleReference): ImportEqualsDeclaration;
- function updateImportEqualsDeclaration(node: ImportEqualsDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, name: Identifier, moduleReference: ModuleReference): ImportEqualsDeclaration;
- function createImportDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, importClause: ImportClause | undefined, moduleSpecifier: Expression): ImportDeclaration;
- function updateImportDeclaration(node: ImportDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, importClause: ImportClause | undefined, moduleSpecifier: Expression): ImportDeclaration;
- function createImportClause(name: Identifier | undefined, namedBindings: NamedImportBindings | undefined, isTypeOnly?: boolean): ImportClause;
- function updateImportClause(node: ImportClause, name: Identifier | undefined, namedBindings: NamedImportBindings | undefined, isTypeOnly: boolean): ImportClause;
- function createNamespaceImport(name: Identifier): NamespaceImport;
- function createNamespaceExport(name: Identifier): NamespaceExport;
- function updateNamespaceImport(node: NamespaceImport, name: Identifier): NamespaceImport;
- function updateNamespaceExport(node: NamespaceExport, name: Identifier): NamespaceExport;
- function createNamedImports(elements: readonly ImportSpecifier[]): NamedImports;
- function updateNamedImports(node: NamedImports, elements: readonly ImportSpecifier[]): NamedImports;
- function createImportSpecifier(propertyName: Identifier | undefined, name: Identifier): ImportSpecifier;
- function updateImportSpecifier(node: ImportSpecifier, propertyName: Identifier | undefined, name: Identifier): ImportSpecifier;
- function createExportAssignment(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, isExportEquals: boolean | undefined, expression: Expression): ExportAssignment;
- function updateExportAssignment(node: ExportAssignment, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, expression: Expression): ExportAssignment;
- function createExportDeclaration(decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, exportClause: NamedExportBindings | undefined, moduleSpecifier?: Expression, isTypeOnly?: boolean): ExportDeclaration;
- function updateExportDeclaration(node: ExportDeclaration, decorators: readonly Decorator[] | undefined, modifiers: readonly Modifier[] | undefined, exportClause: NamedExportBindings | undefined, moduleSpecifier: Expression | undefined, isTypeOnly: boolean): ExportDeclaration;
- function createNamedExports(elements: readonly ExportSpecifier[]): NamedExports;
- function updateNamedExports(node: NamedExports, elements: readonly ExportSpecifier[]): NamedExports;
- function createExportSpecifier(propertyName: string | Identifier | undefined, name: string | Identifier): ExportSpecifier;
- function updateExportSpecifier(node: ExportSpecifier, propertyName: Identifier | undefined, name: Identifier): ExportSpecifier;
- function createExternalModuleReference(expression: Expression): ExternalModuleReference;
- function updateExternalModuleReference(node: ExternalModuleReference, expression: Expression): ExternalModuleReference;
- function createJsxElement(openingElement: JsxOpeningElement, children: readonly JsxChild[], closingElement: JsxClosingElement): JsxElement;
- function updateJsxElement(node: JsxElement, openingElement: JsxOpeningElement, children: readonly JsxChild[], closingElement: JsxClosingElement): JsxElement;
- function createJsxSelfClosingElement(tagName: JsxTagNameExpression, typeArguments: readonly TypeNode[] | undefined, attributes: JsxAttributes): JsxSelfClosingElement;
- function updateJsxSelfClosingElement(node: JsxSelfClosingElement, tagName: JsxTagNameExpression, typeArguments: readonly TypeNode[] | undefined, attributes: JsxAttributes): JsxSelfClosingElement;
- function createJsxOpeningElement(tagName: JsxTagNameExpression, typeArguments: readonly TypeNode[] | undefined, attributes: JsxAttributes): JsxOpeningElement;
- function updateJsxOpeningElement(node: JsxOpeningElement, tagName: JsxTagNameExpression, typeArguments: readonly TypeNode[] | undefined, attributes: JsxAttributes): JsxOpeningElement;
- function createJsxClosingElement(tagName: JsxTagNameExpression): JsxClosingElement;
- function updateJsxClosingElement(node: JsxClosingElement, tagName: JsxTagNameExpression): JsxClosingElement;
- function createJsxFragment(openingFragment: JsxOpeningFragment, children: readonly JsxChild[], closingFragment: JsxClosingFragment): JsxFragment;
- function createJsxText(text: string, containsOnlyTriviaWhiteSpaces?: boolean): JsxText;
- function updateJsxText(node: JsxText, text: string, containsOnlyTriviaWhiteSpaces?: boolean): JsxText;
- function createJsxOpeningFragment(): JsxOpeningFragment;
- function createJsxJsxClosingFragment(): JsxClosingFragment;
- function updateJsxFragment(node: JsxFragment, openingFragment: JsxOpeningFragment, children: readonly JsxChild[], closingFragment: JsxClosingFragment): JsxFragment;
- function createJsxAttribute(name: Identifier, initializer: StringLiteral | JsxExpression): JsxAttribute;
- function updateJsxAttribute(node: JsxAttribute, name: Identifier, initializer: StringLiteral | JsxExpression): JsxAttribute;
- function createJsxAttributes(properties: readonly JsxAttributeLike[]): JsxAttributes;
- function updateJsxAttributes(node: JsxAttributes, properties: readonly JsxAttributeLike[]): JsxAttributes;
- function createJsxSpreadAttribute(expression: Expression): JsxSpreadAttribute;
- function updateJsxSpreadAttribute(node: JsxSpreadAttribute, expression: Expression): JsxSpreadAttribute;
- function createJsxExpression(dotDotDotToken: DotDotDotToken | undefined, expression: Expression | undefined): JsxExpression;
- function updateJsxExpression(node: JsxExpression, expression: Expression | undefined): JsxExpression;
- function createCaseClause(expression: Expression, statements: readonly Statement[]): CaseClause;
- function updateCaseClause(node: CaseClause, expression: Expression, statements: readonly Statement[]): CaseClause;
- function createDefaultClause(statements: readonly Statement[]): DefaultClause;
- function updateDefaultClause(node: DefaultClause, statements: readonly Statement[]): DefaultClause;
- function createHeritageClause(token: HeritageClause["token"], types: readonly ExpressionWithTypeArguments[]): HeritageClause;
- function updateHeritageClause(node: HeritageClause, types: readonly ExpressionWithTypeArguments[]): HeritageClause;
- function createCatchClause(variableDeclaration: string | VariableDeclaration | undefined, block: Block): CatchClause;
- function updateCatchClause(node: CatchClause, variableDeclaration: VariableDeclaration | undefined, block: Block): CatchClause;
- function createPropertyAssignment(name: string | PropertyName, initializer: Expression): PropertyAssignment;
- function updatePropertyAssignment(node: PropertyAssignment, name: PropertyName, initializer: Expression): PropertyAssignment;
- function createShorthandPropertyAssignment(name: string | Identifier, objectAssignmentInitializer?: Expression): ShorthandPropertyAssignment;
- function updateShorthandPropertyAssignment(node: ShorthandPropertyAssignment, name: Identifier, objectAssignmentInitializer: Expression | undefined): ShorthandPropertyAssignment;
- function createSpreadAssignment(expression: Expression): SpreadAssignment;
- function updateSpreadAssignment(node: SpreadAssignment, expression: Expression): SpreadAssignment;
- function createEnumMember(name: string | PropertyName, initializer?: Expression): EnumMember;
- function updateEnumMember(node: EnumMember, name: PropertyName, initializer: Expression | undefined): EnumMember;
- function updateSourceFileNode(node: SourceFile, statements: readonly Statement[], isDeclarationFile?: boolean, referencedFiles?: SourceFile["referencedFiles"], typeReferences?: SourceFile["typeReferenceDirectives"], hasNoDefaultLib?: boolean, libReferences?: SourceFile["libReferenceDirectives"]): SourceFile;
- /**
- * Creates a shallow, memberwise clone of a node for mutation.
- */
- function getMutableClone<T extends Node>(node: T): T;
- /**
- * Creates a synthetic statement to act as a placeholder for a not-emitted statement in
- * order to preserve comments.
- *
- * @param original The original statement.
- */
- function createNotEmittedStatement(original: Node): NotEmittedStatement;
- /**
- * Creates a synthetic expression to act as a placeholder for a not-emitted expression in
- * order to preserve comments or sourcemap positions.
- *
- * @param expression The inner expression to emit.
- * @param original The original outer expression.
- * @param location The location for the expression. Defaults to the positions from "original" if provided.
- */
- function createPartiallyEmittedExpression(expression: Expression, original?: Node): PartiallyEmittedExpression;
- function updatePartiallyEmittedExpression(node: PartiallyEmittedExpression, expression: Expression): PartiallyEmittedExpression;
- function createCommaList(elements: readonly Expression[]): CommaListExpression;
- function updateCommaList(node: CommaListExpression, elements: readonly Expression[]): CommaListExpression;
- function createBundle(sourceFiles: readonly SourceFile[], prepends?: readonly (UnparsedSource | InputFiles)[]): Bundle;
- 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;
- function updateBundle(node: Bundle, sourceFiles: readonly SourceFile[], prepends?: readonly (UnparsedSource | InputFiles)[]): Bundle;
- function createImmediatelyInvokedFunctionExpression(statements: readonly Statement[]): CallExpression;
- function createImmediatelyInvokedFunctionExpression(statements: readonly Statement[], param: ParameterDeclaration, paramValue: Expression): CallExpression;
- function createImmediatelyInvokedArrowFunction(statements: readonly Statement[]): CallExpression;
- function createImmediatelyInvokedArrowFunction(statements: readonly Statement[], param: ParameterDeclaration, paramValue: Expression): CallExpression;
- function createComma(left: Expression, right: Expression): Expression;
- function createLessThan(left: Expression, right: Expression): Expression;
- function createAssignment(left: ObjectLiteralExpression | ArrayLiteralExpression, right: Expression): DestructuringAssignment;
- function createAssignment(left: Expression, right: Expression): BinaryExpression;
- function createStrictEquality(left: Expression, right: Expression): BinaryExpression;
- function createStrictInequality(left: Expression, right: Expression): BinaryExpression;
- function createAdd(left: Expression, right: Expression): BinaryExpression;
- function createSubtract(left: Expression, right: Expression): BinaryExpression;
- function createPostfixIncrement(operand: Expression): PostfixUnaryExpression;
- function createLogicalAnd(left: Expression, right: Expression): BinaryExpression;
- function createLogicalOr(left: Expression, right: Expression): BinaryExpression;
- function createNullishCoalesce(left: Expression, right: Expression): BinaryExpression;
- function createLogicalNot(operand: Expression): PrefixUnaryExpression;
- function createVoidZero(): VoidExpression;
- function createExportDefault(expression: Expression): ExportAssignment;
- function createExternalModuleExport(exportName: Identifier): ExportDeclaration;
- /**
- * Clears any EmitNode entries from parse-tree nodes.
- * @param sourceFile A source file.
- */
- function disposeEmitNodes(sourceFile: SourceFile): void;
- function setTextRange<T extends TextRange>(range: T, location: TextRange | undefined): T;
- /**
- * Sets flags that control emit behavior of a node.
- */
- function setEmitFlags<T extends Node>(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<T extends Node>(node: T, range: SourceMapRange | undefined): T;
- /**
- * Create an external source map source file reference
- */
- function createSourceMapSource(fileName: string, text: string, skipTrivia?: (pos: number) => number): SourceMapSource;
- /**
- * 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<T extends Node>(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<T extends Node>(node: T, range: TextRange): T;
- function getSyntheticLeadingComments(node: Node): SynthesizedComment[] | undefined;
- function setSyntheticLeadingComments<T extends Node>(node: T, comments: SynthesizedComment[] | undefined): T;
- function addSyntheticLeadingComment<T extends Node>(node: T, kind: SyntaxKind.SingleLineCommentTrivia | SyntaxKind.MultiLineCommentTrivia, text: string, hasTrailingNewLine?: boolean): T;
- function getSyntheticTrailingComments(node: Node): SynthesizedComment[] | undefined;
- function setSyntheticTrailingComments<T extends Node>(node: T, comments: SynthesizedComment[] | undefined): T;
- function addSyntheticTrailingComment<T extends Node>(node: T, kind: SyntaxKind.SingleLineCommentTrivia | SyntaxKind.MultiLineCommentTrivia, text: string, hasTrailingNewLine?: boolean): T;
- function moveSyntheticComments<T extends Node>(node: T, original: Node): T;
- /**
- * Gets the constant value to emit for an expression.
- */
- function getConstantValue(node: PropertyAccessExpression | ElementAccessExpression): string | number | undefined;
- /**
- * Sets the constant value to emit for an expression.
- */
- function setConstantValue(node: PropertyAccessExpression | ElementAccessExpression, value: string | number): PropertyAccessExpression | ElementAccessExpression;
- /**
- * Adds an EmitHelper to a node.
- */
- function addEmitHelper<T extends Node>(node: T, helper: EmitHelper): T;
- /**
- * Add EmitHelpers to a node.
- */
- function addEmitHelpers<T extends Node>(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;
- function setOriginalNode<T extends Node>(node: T, original: Node | undefined): T;
-}
-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<T extends Node>(node: T | undefined, visitor: Visitor | undefined, test?: (node: Node) => boolean, lift?: (node: NodeArray<Node>) => 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<T extends Node>(node: T | undefined, visitor: Visitor | undefined, test?: (node: Node) => boolean, lift?: (node: NodeArray<Node>) => 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<T extends Node>(nodes: NodeArray<T> | undefined, visitor: Visitor, test?: (node: Node) => boolean, start?: number, count?: number): NodeArray<T>;
- /**
- * 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<T extends Node>(nodes: NodeArray<T> | undefined, visitor: Visitor, test?: (node: Node) => boolean, start?: number, count?: number): NodeArray<T> | 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<Statement>, visitor: Visitor, context: TransformationContext, start?: number, ensureUseStrict?: boolean): NodeArray<Statement>;
- /**
- * Starts a new lexical environment and visits a parameter list, suspending the lexical
- * environment upon completion.
- */
- function visitParameterList(nodes: NodeArray<ParameterDeclaration>, visitor: Visitor, context: TransformationContext, nodesVisitor?: <T extends Node>(nodes: NodeArray<T>, visitor: Visitor, test?: (node: Node) => boolean, start?: number, count?: number) => NodeArray<T>): NodeArray<ParameterDeclaration>;
- function visitParameterList(nodes: NodeArray<ParameterDeclaration> | undefined, visitor: Visitor, context: TransformationContext, nodesVisitor?: <T extends Node>(nodes: NodeArray<T> | undefined, visitor: Visitor, test?: (node: Node) => boolean, start?: number, count?: number) => NodeArray<T> | undefined): NodeArray<ParameterDeclaration> | 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<T extends Node>(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<T extends Node>(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<T> = {
- 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<readonly Diagnostic[]>;
- }
- /**
- * 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<EmitResult>;
- }
- /**
- * 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<T extends BuilderProgram> {
- rootNames: readonly string[];
- options: CompilerOptions;
- configFileParsingDiagnostics?: readonly Diagnostic[];
- projectReferences?: readonly ProjectReference[];
- host?: CompilerHost;
- createProgram?: CreateProgram<T>;
- }
- function createIncrementalProgram<T extends BuilderProgram = EmitAndSemanticDiagnosticsBuilderProgram>({ rootNames, options, configFileParsingDiagnostics, projectReferences, host, createProgram }: IncrementalProgramOptions<T>): 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<T extends BuilderProgram> = (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<T extends BuilderProgram> {
- /**
- * Used to create the program when need for program creation or recreation detected
- */
- createProgram: CreateProgram<T>;
- 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<T extends BuilderProgram> extends ProgramHost<T>, 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<T extends BuilderProgram> extends WatchCompilerHost<T> {
- /** 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<T extends BuilderProgram> extends WatchCompilerHost<T>, 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<T> {
- /** 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<T> extends Watch<T> {
- }
- /**
- * Creates the watch that generates program using the root files and compiler options
- */
- interface WatchOfFilesAndCompilerOptions<T> extends Watch<T> {
- /** 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<T extends BuilderProgram>(configFileName: string, optionsToExtend: CompilerOptions | undefined, system: System, createProgram?: CreateProgram<T>, reportDiagnostic?: DiagnosticReporter, reportWatchStatus?: WatchStatusReporter, watchOptionsToExtend?: WatchOptions, extraFileExtensions?: readonly FileExtensionInfo[]): WatchCompilerHostOfConfigFile<T>;
- function createWatchCompilerHost<T extends BuilderProgram>(rootFiles: string[], options: CompilerOptions, system: System, createProgram?: CreateProgram<T>, reportDiagnostic?: DiagnosticReporter, reportWatchStatus?: WatchStatusReporter, projectReferences?: readonly ProjectReference[], watchOptions?: WatchOptions): WatchCompilerHostOfFilesAndCompilerOptions<T>;
- /**
- * Creates the watch from the host for root files and compiler options
- */
- function createWatchProgram<T extends BuilderProgram>(host: WatchCompilerHostOfFilesAndCompilerOptions<T>): WatchOfFilesAndCompilerOptions<T>;
- /**
- * Creates the watch from the host for config file
- */
- function createWatchProgram<T extends BuilderProgram>(host: WatchCompilerHostOfConfigFile<T>): WatchOfConfigFile<T>;
-}
-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<T extends BuilderProgram> extends ProgramHost<T> {
- 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<T extends BuilderProgram> extends SolutionBuilderHostBase<T> {
- reportErrorSummary?: ReportEmitErrorSummary;
- }
- interface SolutionBuilderWithWatchHost<T extends BuilderProgram> extends SolutionBuilderHostBase<T>, WatchHost {
- }
- interface SolutionBuilder<T extends BuilderProgram> {
- build(project?: string, cancellationToken?: CancellationToken): ExitStatus;
- clean(project?: string): ExitStatus;
- buildReferences(project: string, cancellationToken?: CancellationToken): ExitStatus;
- cleanReferences(project?: string): ExitStatus;
- getNextInvalidatedProject(cancellationToken?: CancellationToken): InvalidatedProject<T> | 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<T extends BuilderProgram = EmitAndSemanticDiagnosticsBuilderProgram>(system?: System, createProgram?: CreateProgram<T>, reportDiagnostic?: DiagnosticReporter, reportSolutionBuilderStatus?: DiagnosticReporter, reportErrorSummary?: ReportEmitErrorSummary): SolutionBuilderHost<T>;
- function createSolutionBuilderWithWatchHost<T extends BuilderProgram = EmitAndSemanticDiagnosticsBuilderProgram>(system?: System, createProgram?: CreateProgram<T>, reportDiagnostic?: DiagnosticReporter, reportSolutionBuilderStatus?: DiagnosticReporter, reportWatchStatus?: WatchStatusReporter): SolutionBuilderWithWatchHost<T>;
- function createSolutionBuilder<T extends BuilderProgram>(host: SolutionBuilderHost<T>, rootNames: readonly string[], defaultOptions: BuildOptions): SolutionBuilder<T>;
- function createSolutionBuilderWithWatch<T extends BuilderProgram>(host: SolutionBuilderWithWatchHost<T>, rootNames: readonly string[], defaultOptions: BuildOptions, baseWatchOptions?: WatchOptions): SolutionBuilder<T>;
- 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<T extends BuilderProgram> 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<readonly Diagnostic[]>;
- emit(targetSourceFile?: SourceFile, writeFile?: WriteFileCallback, cancellationToken?: CancellationToken, emitOnlyDtsFiles?: boolean, customTransformers?: CustomTransformers): EmitResult | undefined;
- }
- interface UpdateBundleProject<T extends BuilderProgram> extends InvalidatedProjectBase {
- readonly kind: InvalidatedProjectKind.UpdateBundle;
- emit(writeFile?: WriteFileCallback, customTransformers?: CustomTransformers): EmitResult | BuildInvalidedProject<T> | undefined;
- }
- type InvalidatedProject<T extends BuilderProgram> = UpdateOutputFileStampsProject | BuildInvalidedProject<T> | UpdateBundleProject<T>;
-}
-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<string>;
- 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;
- }
- 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<string>;
- 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<T>(cbNode: (node: Node) => T | undefined, cbNodeArray?: (nodes: NodeArray<Node>) => 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 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<ApplyCodeActionCommandResult>;
- writeFile?(fileName: string, content: string): void;
- }
- type WithMetadata<T> = T & {
- metadata?: unknown;
- };
- 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[];
- /** @deprecated Use getEncodedSemanticClassifications instead. */
- getSemanticClassifications(fileName: string, span: TextSpan): ClassifiedSpan[];
- getEncodedSyntacticClassifications(fileName: string, span: TextSpan): Classifications;
- getEncodedSemanticClassifications(fileName: string, span: TextSpan): 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<CompletionInfo> | 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<ApplyCodeActionCommandResult>;
- applyCodeActionCommand(action: CodeActionCommand[], formatSettings?: FormatCodeSettings): Promise<ApplyCodeActionCommandResult[]>;
- applyCodeActionCommand(action: CodeActionCommand | CodeActionCommand[], formatSettings?: FormatCodeSettings): Promise<ApplyCodeActionCommandResult | ApplyCodeActionCommandResult[]>;
- /** @deprecated `fileName` will be ignored */
- applyCodeActionCommand(fileName: string, action: CodeActionCommand): Promise<ApplyCodeActionCommandResult>;
- /** @deprecated `fileName` will be ignored */
- applyCodeActionCommand(fileName: string, action: CodeActionCommand[]): Promise<ApplyCodeActionCommandResult[]>;
- /** @deprecated `fileName` will be ignored */
- applyCodeActionCommand(fileName: string, action: CodeActionCommand | CodeActionCommand[]): Promise<ApplyCodeActionCommandResult | ApplyCodeActionCommandResult[]>;
- getApplicableRefactors(fileName: string, positionOrRange: number | TextRange, preferences: UserPreferences | undefined): 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;
- 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;
- }
- /**
- * 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. "<class>". */
- 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;
- file: string;
- span: TextSpan;
- selectionSpan: TextSpan;
- }
- 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 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[];
- }
- 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;
- /**
- * 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;
- }
- 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",
- /**
- * <JsxTagName attribute1 attribute2={0} />
- */
- 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",
- 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<string>;
- 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, syntaxOnly?: boolean): 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<T extends Node>(source: T | T[], transformers: TransformerFactory<T>[], compilerOptions?: CompilerOptions): TransformationResult<T>;
-}
-
-export = ts;
\ No newline at end of file
projects / dotfiles / .git / blobdiff