Options
All
  • Public
  • Public/Protected
  • All
Menu

typescript

Index

Namespaces

Interfaces

Type aliases

Type aliases

AbstractKeyword

AbstractKeyword: ModifierToken<AbstractKeyword>

AccessExpression

AccessibilityModifier

AccessibilityModifier: PublicKeyword | PrivateKeyword | ProtectedKeyword

AccessorDeclaration

AdditiveOperator

AdditiveOperator: PlusToken | MinusToken

AdditiveOperatorOrHigher

AffectedFileResult

AffectedFileResult<T>: { affected: SourceFile | Program; result: T } | undefined

Type parameters

  • T

ArrayBindingElement

ArrayBindingElement: BindingElement | OmittedExpression

ArrayBindingOrAssignmentElement

ArrayBindingOrAssignmentPattern

ArrayBindingOrAssignmentPattern: ArrayBindingPattern | ArrayLiteralExpression

AssertionExpression

AssertionExpression: TypeAssertion | AsExpression

AssertsKeyword

AssertsKeyword: KeywordToken<AssertsKeyword>

AssertsToken

AssertsToken: AssertsKeyword
deprecated

Use AssertsKeyword instead.

AssignmentOperator

AssignmentOperatorOrHigher

AssignmentOperatorToken

AssignmentOperatorToken: Token<AssignmentOperator>

AssignmentPattern

AsteriskToken

AsyncKeyword

AwaitKeyword

AwaitKeyword: KeywordToken<AwaitKeyword>

AwaitKeywordToken

AwaitKeywordToken: AwaitKeyword
deprecated

Use AwaitKeyword instead.

BaseType

BinaryOperator

BinaryOperatorToken

BinaryOperatorToken: Token<BinaryOperator>

BindingName

BindingName: Identifier | BindingPattern

BindingOrAssignmentElement

BindingOrAssignmentElementRestIndicator

BindingOrAssignmentElementRestIndicator: DotDotDotToken | SpreadElement | SpreadAssignment

BindingOrAssignmentElementTarget

BindingOrAssignmentPattern

BindingPattern

BitwiseOperator

BitwiseOperator: AmpersandToken | BarToken | CaretToken

BitwiseOperatorOrHigher

BitwiseOperatorOrHigher: EqualityOperatorOrHigher | BitwiseOperator

BlockLike

BooleanLiteral

BooleanLiteral: TrueLiteral | FalseLiteral

BreakOrContinueStatement

BreakOrContinueStatement: BreakStatement | ContinueStatement

CallLikeExpression

CaseOrDefaultClause

CaseOrDefaultClause: CaseClause | DefaultClause

ClassLikeDeclaration

ClassLikeDeclaration: ClassDeclaration | ClassExpression

ClassMemberModifier

CodeActionCommand

CodeActionCommand: InstallPackageAction

ColonToken

CommentKind

CompilerOptionsValue

CompilerOptionsValue: string | number | boolean | (string | number)[] | string[] | MapLike<string[]> | PluginImport[] | ProjectReference[] | null | undefined

CompletionsTriggerCharacter

CompletionsTriggerCharacter: "." | "\"" | "'" | "`" | "/" | "@" | "<" | "#"

CompoundAssignmentOperator

ConciseBody

ConciseBody: FunctionBody | Expression

ConstKeyword

CreateProgram

CreateProgram<T>: (rootNames: readonly string[] | undefined, options: CompilerOptions | undefined, host?: CompilerHost, oldProgram?: T, configFileParsingDiagnostics?: readonly Diagnostic[], projectReferences?: readonly ProjectReference[]) => T

Create the program with rootNames and options, if they are undefined, oldProgram and new configFile diagnostics create new program

Type parameters

Type declaration

CustomTransformerFactory

CustomTransformerFactory: (context: TransformationContext) => CustomTransformer

Type declaration

DeclarationName

DeclarationWithTypeParameterChildren

DeclarationWithTypeParameters

DeclareKeyword

DeclareKeyword: ModifierToken<DeclareKeyword>

DefaultKeyword

DefaultKeyword: ModifierToken<DefaultKeyword>

DestructuringAssignment

DestructuringPattern

DiagnosticReporter

DiagnosticReporter: (diagnostic: Diagnostic) => void

Type declaration

DirectoryWatcherCallback

DirectoryWatcherCallback: (fileName: string) => void

Type declaration

    • (fileName: string): void
    • Parameters

      • fileName: string

      Returns void

DocumentRegistryBucketKey

DocumentRegistryBucketKey: string & { __bucketKey: any }

DotDotDotToken

DotToken

EmitHelperUniqueNameCallback

EmitHelperUniqueNameCallback: (name: string) => string

Type declaration

    • (name: string): string
    • Parameters

      • name: string

      Returns string

EndOfFileToken

EntityName

EntityNameExpression

EntityNameOrEntityNameExpression

EntityNameOrEntityNameExpression: EntityName | EntityNameExpression

EqualityOperator

EqualityOperatorOrHigher

EqualityOperatorOrHigher: RelationalOperatorOrHigher | EqualityOperator

EqualsGreaterThanToken

EqualsGreaterThanToken: PunctuationToken<EqualsGreaterThanToken>

EqualsToken

ErrorCallback

ErrorCallback: (message: DiagnosticMessage, length: number) => void

Type declaration

ExclamationToken

ExponentiationOperator

ExponentiationOperator: AsteriskAsteriskToken

ExportKeyword

FileWatcherCallback

FileWatcherCallback: (fileName: string, eventKind: FileWatcherEventKind) => void

Type declaration

FlowNode

FlowType

FlowType: Type | IncompleteType

ForInOrOfStatement

ForInOrOfStatement: ForInStatement | ForOfStatement

ForInitializer

FunctionBody

FunctionBody: Block

FunctionLike

FunctionLike: SignatureDeclaration
deprecated

Use SignatureDeclaration

FunctionLikeDeclaration

FunctionOrConstructorTypeNode

FunctionOrConstructorTypeNode: FunctionTypeNode | ConstructorTypeNode

HasExpressionInitializer

HasInitializer

HasJSDoc

HasType

HasTypeArguments

ImportOrExportSpecifier

ImportOrExportSpecifier: ImportSpecifier | ExportSpecifier

IncrementExpression

IncrementExpression: UpdateExpression

Deprecated, please use UpdateExpression

InvalidatedProject

Type parameters

JSDocNamespaceBody

JSDocSyntaxKind

JSDocTypeReferencingNode

JsFileExtensionInfo

JsFileExtensionInfo: FileExtensionInfo
deprecated

Use FileExtensionInfo instead.

JsonObjectExpression

JsxAttributeLike

JsxAttributeLike: JsxAttribute | JsxSpreadAttribute

JsxChild

JsxOpeningLikeElement

JsxOpeningLikeElement: JsxSelfClosingElement | JsxOpeningElement

JsxTagNameExpression

JsxTokenSyntaxKind

KeywordSyntaxKind

KeywordTypeSyntaxKind

LiteralSyntaxKind

LiteralToken

LogicalOperator

LogicalOperatorOrHigher

LogicalOperatorOrHigher: BitwiseOperatorOrHigher | LogicalOperator

LogicalOrCoalescingAssignmentOperator

MinusToken

Modifier

ModifierSyntaxKind

ModifiersArray

ModifiersArray: NodeArray<Modifier>

ModuleBody

ModuleName

ModuleReference

MultiplicativeOperator

MultiplicativeOperator: AsteriskToken | SlashToken | PercentToken

MultiplicativeOperatorOrHigher

MultiplicativeOperatorOrHigher: ExponentiationOperator | MultiplicativeOperator

NamedExportBindings

NamedExportBindings: NamespaceExport | NamedExports

NamedImportBindings

NamedImportBindings: NamespaceImport | NamedImports

NamedImportsOrExports

NamedImportsOrExports: NamedImports | NamedExports

NamespaceBody

ObjectBindingOrAssignmentElement

ObjectBindingOrAssignmentPattern

ObjectBindingOrAssignmentPattern: ObjectBindingPattern | ObjectLiteralExpression

ObjectLiteralElementLike

Unlike ObjectLiteralElement, excludes JSXAttribute and JSXSpreadAttribute.

ObjectTypeDeclaration

OptionalChain

OrganizeImportsScope

OrganizeImportsScope: CombinedCodeFixScope

ParameterPropertyDeclaration

ParameterPropertyDeclaration: ParameterDeclaration & { name: Identifier; parent: ConstructorDeclaration }

ParameterPropertyModifier

ParameterPropertyModifier: AccessibilityModifier | ReadonlyKeyword

Path

Path: string & { __pathBrand: any }

PlusToken

PostfixUnaryOperator

PostfixUnaryOperator: PlusPlusToken | MinusMinusToken

PrefixUnaryOperator

PrivateKeyword

PrivateKeyword: ModifierToken<PrivateKeyword>

PropertyName

PropertyNameLiteral

ProtectedKeyword

ProtectedKeyword: ModifierToken<ProtectedKeyword>

PseudoLiteralSyntaxKind

PseudoLiteralSyntaxKind: TemplateHead | TemplateMiddle | TemplateTail

PseudoLiteralToken

PseudoLiteralToken: TemplateHead | TemplateMiddle | TemplateTail

PublicKeyword

PunctuationSyntaxKind

QuestionDotToken

QuestionToken

ReadonlyKeyword

ReadonlyKeyword: ModifierToken<ReadonlyKeyword>

ReadonlyToken

ReadonlyToken: ReadonlyKeyword
deprecated

Use ReadonlyKeyword instead.

RefactorTriggerReason

RefactorTriggerReason: "implicit" | "invoked"

RelationalOperator

RelationalOperatorOrHigher

RelationalOperatorOrHigher: ShiftOperatorOrHigher | RelationalOperator

RenameInfo

ReportEmitErrorSummary

ReportEmitErrorSummary: (errorCount: number) => void

Type declaration

    • (errorCount: number): void
    • Parameters

      • errorCount: number

      Returns void

ResolvedConfigFileName

ResolvedConfigFileName: string & { _isResolvedConfigFileName: never }

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"

ShiftOperator

ShiftOperatorOrHigher

ShiftOperatorOrHigher: AdditiveOperatorOrHigher | ShiftOperator

SignatureDeclaration

SignatureHelpRetriggerCharacter

SignatureHelpRetriggerCharacter: SignatureHelpTriggerCharacter | ")"

SignatureHelpTriggerCharacter

SignatureHelpTriggerCharacter: "," | "(" | "<"

SignatureHelpTriggerReason

StaticKeyword

StringLiteralLike

StructuredType

SuperProperty

SymbolTable

SymbolTable based on ES6 Map interface.

TemplateLiteral

TemplateLiteralToken

TokenSyntaxKind

Transformer

Transformer<T>: (node: T) => T

A function that transforms a node.

Type parameters

Type declaration

    • (node: T): T
    • Parameters

      • node: T

      Returns T

TransformerFactory

TransformerFactory<T>: (context: TransformationContext) => Transformer<T>

A function that is used to initialize and return a Transformer callback, which in turn will be used to transform one or more nodes.

Type parameters

Type declaration

TriviaSyntaxKind

TypeOfTag

TypeOfTag: "undefined" | "number" | "bigint" | "boolean" | "string" | "symbol" | "object" | "function"

TypeOnlyCompatibleAliasDeclaration

TypePredicate

TypeReferenceType

TypeVariable

UnionOrIntersectionTypeNode

UnionOrIntersectionTypeNode: UnionTypeNode | IntersectionTypeNode

UnparsedNode

UnparsedSourceText

UnparsedSourceText: UnparsedPrepend | UnparsedTextLike

VariableLikeDeclaration

VisitResult

VisitResult<T>: T | T[] | undefined

Type parameters

Visitor

Visitor: (node: Node) => VisitResult<Node>

A function that accepts and possibly transforms a node.

Type declaration

WatchStatusReporter

WatchStatusReporter: (diagnostic: Diagnostic, newLine: string, options: CompilerOptions, errorCount?: number) => void

Type declaration

WithMetadata

WithMetadata<T>: T & { metadata?: unknown }

Type parameters

  • T

WriteFileCallback

WriteFileCallback: (fileName: string, data: string, writeByteOrderMark: boolean, onError?: (message: string) => void, sourceFiles?: readonly SourceFile[]) => void

Type declaration

    • (fileName: string, data: string, writeByteOrderMark: boolean, onError?: (message: string) => void, sourceFiles?: readonly SourceFile[]): void
    • Parameters

      • fileName: string
      • data: string
      • writeByteOrderMark: boolean
      • Optional onError: (message: string) => void
          • (message: string): void
          • Parameters

            • message: string

            Returns void

      • Optional sourceFiles: readonly SourceFile[]

      Returns void

__String

__String: (string & { __escapedIdentifier: void }) | (void & { __escapedIdentifier: void }) | InternalSymbolName

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.

Generated using TypeDoc