Interface NodeFactory

createAdd

• createAdd(left: Expression, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • right: Expression

  Returns BinaryExpression

createArrayBindingPattern

• createArrayBindingPattern(elements: readonly ArrayBindingElement[]): ArrayBindingPattern

• Parameters

  • elements: readonly ArrayBindingElement[]

  Returns ArrayBindingPattern

createArrayLiteralExpression

• createArrayLiteralExpression(elements?: readonly Expression[], multiLine?: boolean): ArrayLiteralExpression

• Parameters

  • Optional elements: readonly Expression[]

  • Optional multiLine: boolean

  Returns ArrayLiteralExpression

createArrayTypeNode

• createArrayTypeNode(elementType: TypeNode): ArrayTypeNode

• Parameters

  • elementType: TypeNode

  Returns ArrayTypeNode

createArrowFunction

• createArrowFunction(modifiers: readonly Modifier[], typeParameters: readonly TypeParameterDeclaration[], parameters: readonly ParameterDeclaration[], type: TypeNode, equalsGreaterThanToken: EqualsGreaterThanToken, body: ConciseBody): ArrowFunction

• Parameters

  • modifiers: readonly Modifier[]

  • typeParameters: readonly TypeParameterDeclaration[]

  • parameters: readonly ParameterDeclaration[]

  • type: TypeNode

  • equalsGreaterThanToken: EqualsGreaterThanToken

  • body: ConciseBody

  Returns ArrowFunction

createAsExpression

• createAsExpression(expression: Expression, type: TypeNode): AsExpression

• Parameters

  • expression: Expression

  • type: TypeNode

  Returns AsExpression

createAssignment

• createAssignment(left: ObjectLiteralExpression | ArrayLiteralExpression, right: Expression): DestructuringAssignment
• createAssignment(left: Expression, right: Expression): AssignmentExpression<EqualsToken>

• Parameters

  • left: ObjectLiteralExpression | ArrayLiteralExpression

  • right: Expression

  Returns DestructuringAssignment

• Parameters

  • left: Expression

  • right: Expression

  Returns AssignmentExpression<EqualsToken>

createAwaitExpression

• createAwaitExpression(expression: Expression): AwaitExpression

• Parameters

  • expression: Expression

  Returns AwaitExpression

createBigIntLiteral

• createBigIntLiteral(value: string | PseudoBigInt): BigIntLiteral

• Parameters

  • value: string | PseudoBigInt

  Returns BigIntLiteral

createBinaryExpression

• createBinaryExpression(left: Expression, operator: BinaryOperator | BinaryOperatorToken, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • operator: BinaryOperator | BinaryOperatorToken

  • right: Expression

  Returns BinaryExpression

createBindingElement

• createBindingElement(dotDotDotToken: DotDotDotToken, propertyName: string | PropertyName, name: string | BindingName, initializer?: Expression): BindingElement

• Parameters

  • dotDotDotToken: DotDotDotToken

  • propertyName: string | PropertyName

  • name: string | BindingName

  • Optional initializer: Expression

  Returns BindingElement

createBitwiseAnd

• createBitwiseAnd(left: Expression, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • right: Expression

  Returns BinaryExpression

createBitwiseNot

• createBitwiseNot(operand: Expression): PrefixUnaryExpression

• Parameters

  • operand: Expression

  Returns PrefixUnaryExpression

createBitwiseOr

• createBitwiseOr(left: Expression, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • right: Expression

  Returns BinaryExpression

createBitwiseXor

• createBitwiseXor(left: Expression, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • right: Expression

  Returns BinaryExpression

createBlock

• createBlock(statements: readonly Statement[], multiLine?: boolean): Block

• Parameters

  • statements: readonly Statement[]

  • Optional multiLine: boolean

  Returns Block

createBreakStatement

• createBreakStatement(label?: string | Identifier): BreakStatement

• Parameters

  • Optional label: string | Identifier

  Returns BreakStatement

createBundle

• createBundle(sourceFiles: readonly SourceFile[], prepends?: readonly (InputFiles | UnparsedSource)[]): Bundle

• Parameters

  • sourceFiles: readonly SourceFile[]

  • Optional prepends: readonly (InputFiles | UnparsedSource)[]

  Returns Bundle

createCallChain

• createCallChain(expression: Expression, questionDotToken: QuestionDotToken, typeArguments: readonly TypeNode[], argumentsArray: readonly Expression[]): CallChain

• Parameters

  • expression: Expression

  • questionDotToken: QuestionDotToken

  • typeArguments: readonly TypeNode[]

  • argumentsArray: readonly Expression[]

  Returns CallChain

createCallExpression

• createCallExpression(expression: Expression, typeArguments: readonly TypeNode[], argumentsArray: readonly Expression[]): CallExpression

• Parameters

  • expression: Expression

  • typeArguments: readonly TypeNode[]

  • argumentsArray: readonly Expression[]

  Returns CallExpression

createCallSignature

• createCallSignature(typeParameters: readonly TypeParameterDeclaration[], parameters: readonly ParameterDeclaration[], type: TypeNode): CallSignatureDeclaration

• Parameters

  • typeParameters: readonly TypeParameterDeclaration[]

  • parameters: readonly ParameterDeclaration[]

  • type: TypeNode

  Returns CallSignatureDeclaration

createCaseBlock

• createCaseBlock(clauses: readonly CaseOrDefaultClause[]): CaseBlock

• Parameters

  • clauses: readonly CaseOrDefaultClause[]

  Returns CaseBlock

createCaseClause

• createCaseClause(expression: Expression, statements: readonly Statement[]): CaseClause

• Parameters

  • expression: Expression

  • statements: readonly Statement[]

  Returns CaseClause

createCatchClause

• createCatchClause(variableDeclaration: string | VariableDeclaration, block: Block): CatchClause

• Parameters

  • variableDeclaration: string | VariableDeclaration

  • block: Block

  Returns CatchClause

createClassDeclaration

• createClassDeclaration(decorators: readonly Decorator[], modifiers: readonly Modifier[], name: string | Identifier, typeParameters: readonly TypeParameterDeclaration[], heritageClauses: readonly HeritageClause[], members: readonly ClassElement[]): ClassDeclaration

• Parameters

  • decorators: readonly Decorator[]

  • modifiers: readonly Modifier[]

  • name: string | Identifier

  • typeParameters: readonly TypeParameterDeclaration[]

  • heritageClauses: readonly HeritageClause[]

  • members: readonly ClassElement[]

  Returns ClassDeclaration

createClassExpression

• createClassExpression(decorators: readonly Decorator[], modifiers: readonly Modifier[], name: string | Identifier, typeParameters: readonly TypeParameterDeclaration[], heritageClauses: readonly HeritageClause[], members: readonly ClassElement[]): ClassExpression

• Parameters

  • decorators: readonly Decorator[]

  • modifiers: readonly Modifier[]

  • name: string | Identifier

  • typeParameters: readonly TypeParameterDeclaration[]

  • heritageClauses: readonly HeritageClause[]

  • members: readonly ClassElement[]

  Returns ClassExpression

createComma

• createComma(left: Expression, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • right: Expression

  Returns BinaryExpression

createCommaListExpression

• createCommaListExpression(elements: readonly Expression[]): CommaListExpression

• Parameters

  • elements: readonly Expression[]

  Returns CommaListExpression

createComputedPropertyName

• createComputedPropertyName(expression: Expression): ComputedPropertyName

• Parameters

  • expression: Expression

  Returns ComputedPropertyName

createConditionalExpression

• createConditionalExpression(condition: Expression, questionToken: QuestionToken, whenTrue: Expression, colonToken: ColonToken, whenFalse: Expression): ConditionalExpression

• Parameters

  • condition: Expression

  • questionToken: QuestionToken

  • whenTrue: Expression

  • colonToken: ColonToken

  • whenFalse: Expression

  Returns ConditionalExpression

createConditionalTypeNode

• createConditionalTypeNode(checkType: TypeNode, extendsType: TypeNode, trueType: TypeNode, falseType: TypeNode): ConditionalTypeNode

• Parameters

  • checkType: TypeNode

  • extendsType: TypeNode

  • trueType: TypeNode

  • falseType: TypeNode

  Returns ConditionalTypeNode

createConstructSignature

• createConstructSignature(typeParameters: readonly TypeParameterDeclaration[], parameters: readonly ParameterDeclaration[], type: TypeNode): ConstructSignatureDeclaration

• Parameters

  • typeParameters: readonly TypeParameterDeclaration[]

  • parameters: readonly ParameterDeclaration[]

  • type: TypeNode

  Returns ConstructSignatureDeclaration

createConstructorDeclaration

• createConstructorDeclaration(decorators: readonly Decorator[], modifiers: readonly Modifier[], parameters: readonly ParameterDeclaration[], body: Block): ConstructorDeclaration

• Parameters

  • decorators: readonly Decorator[]

  • modifiers: readonly Modifier[]

  • parameters: readonly ParameterDeclaration[]

  • body: Block

  Returns ConstructorDeclaration

createConstructorTypeNode

• createConstructorTypeNode(modifiers: readonly Modifier[], typeParameters: readonly TypeParameterDeclaration[], parameters: readonly ParameterDeclaration[], type: TypeNode): ConstructorTypeNode
• createConstructorTypeNode(typeParameters: readonly TypeParameterDeclaration[], parameters: readonly ParameterDeclaration[], type: TypeNode): ConstructorTypeNode

• Parameters

  • modifiers: readonly Modifier[]

  • typeParameters: readonly TypeParameterDeclaration[]

  • parameters: readonly ParameterDeclaration[]

  • type: TypeNode

  Returns ConstructorTypeNode

• deprecated

  Parameters

  • typeParameters: readonly TypeParameterDeclaration[]

  • parameters: readonly ParameterDeclaration[]

  • type: TypeNode

  Returns ConstructorTypeNode

createContinueStatement

• createContinueStatement(label?: string | Identifier): ContinueStatement

• Parameters

  • Optional label: string | Identifier

  Returns ContinueStatement

createDebuggerStatement

• createDebuggerStatement(): DebuggerStatement

• Returns DebuggerStatement

createDecorator

• createDecorator(expression: Expression): Decorator

• Parameters

  • expression: Expression

  Returns Decorator

createDefaultClause

• createDefaultClause(statements: readonly Statement[]): DefaultClause

• Parameters

  • statements: readonly Statement[]

  Returns DefaultClause

createDeleteExpression

• createDeleteExpression(expression: Expression): DeleteExpression

• Parameters

  • expression: Expression

  Returns DeleteExpression

createDivide

• createDivide(left: Expression, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • right: Expression

  Returns BinaryExpression

createDoStatement

• createDoStatement(statement: Statement, expression: Expression): DoStatement

• Parameters

  • statement: Statement

  • expression: Expression

  Returns DoStatement

createElementAccessChain

• createElementAccessChain(expression: Expression, questionDotToken: QuestionDotToken, index: number | Expression): ElementAccessChain

• Parameters

  • expression: Expression

  • questionDotToken: QuestionDotToken

  • index: number | Expression

  Returns ElementAccessChain

createElementAccessExpression

• createElementAccessExpression(expression: Expression, index: number | Expression): ElementAccessExpression

• Parameters

  • expression: Expression

  • index: number | Expression

  Returns ElementAccessExpression

createEmptyStatement

• createEmptyStatement(): EmptyStatement

• Returns EmptyStatement

createEnumDeclaration

• createEnumDeclaration(decorators: readonly Decorator[], modifiers: readonly Modifier[], name: string | Identifier, members: readonly EnumMember[]): EnumDeclaration

• Parameters

  • decorators: readonly Decorator[]

  • modifiers: readonly Modifier[]

  • name: string | Identifier

  • members: readonly EnumMember[]

  Returns EnumDeclaration

createEnumMember

• createEnumMember(name: string | PropertyName, initializer?: Expression): EnumMember

• Parameters

  • name: string | PropertyName

  • Optional initializer: Expression

  Returns EnumMember

createEquality

• createEquality(left: Expression, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • right: Expression

  Returns BinaryExpression

createExponent

• createExponent(left: Expression, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • right: Expression

  Returns BinaryExpression

createExportAssignment

• createExportAssignment(decorators: readonly Decorator[], modifiers: readonly Modifier[], isExportEquals: boolean, expression: Expression): ExportAssignment

• Parameters

  • decorators: readonly Decorator[]

  • modifiers: readonly Modifier[]

  • isExportEquals: boolean

  • expression: Expression

  Returns ExportAssignment

createExportDeclaration

• createExportDeclaration(decorators: readonly Decorator[], modifiers: readonly Modifier[], isTypeOnly: boolean, exportClause: NamedExportBindings, moduleSpecifier?: Expression): ExportDeclaration

• Parameters

  • decorators: readonly Decorator[]

  • modifiers: readonly Modifier[]

  • isTypeOnly: boolean

  • exportClause: NamedExportBindings

  • Optional moduleSpecifier: Expression

  Returns ExportDeclaration

createExportDefault

• createExportDefault(expression: Expression): ExportAssignment

• Parameters

  • expression: Expression

  Returns ExportAssignment

createExportSpecifier

• createExportSpecifier(propertyName: string | Identifier, name: string | Identifier): ExportSpecifier

• Parameters

  • propertyName: string | Identifier

  • name: string | Identifier

  Returns ExportSpecifier

createExpressionStatement

• createExpressionStatement(expression: Expression): ExpressionStatement

• Parameters

  • expression: Expression

  Returns ExpressionStatement

createExpressionWithTypeArguments

• createExpressionWithTypeArguments(expression: Expression, typeArguments: readonly TypeNode[]): ExpressionWithTypeArguments

• Parameters

  • expression: Expression

  • typeArguments: readonly TypeNode[]

  Returns ExpressionWithTypeArguments

createExternalModuleExport

• createExternalModuleExport(exportName: Identifier): ExportDeclaration

• Parameters

  • exportName: Identifier

  Returns ExportDeclaration

createExternalModuleReference

• createExternalModuleReference(expression: Expression): ExternalModuleReference

• Parameters

  • expression: Expression

  Returns ExternalModuleReference

createFalse

• createFalse(): FalseLiteral

• Returns FalseLiteral

createForInStatement

• createForInStatement(initializer: ForInitializer, expression: Expression, statement: Statement): ForInStatement

• Parameters

  • initializer: ForInitializer

  • expression: Expression

  • statement: Statement

  Returns ForInStatement

createForOfStatement

• createForOfStatement(awaitModifier: AwaitKeyword, initializer: ForInitializer, expression: Expression, statement: Statement): ForOfStatement

• Parameters

  • awaitModifier: AwaitKeyword

  • initializer: ForInitializer

  • expression: Expression

  • statement: Statement

  Returns ForOfStatement

createForStatement

• createForStatement(initializer: ForInitializer, condition: Expression, incrementor: Expression, statement: Statement): ForStatement

• Parameters

  • initializer: ForInitializer

  • condition: Expression

  • incrementor: Expression

  • statement: Statement

  Returns ForStatement

createFunctionDeclaration

• createFunctionDeclaration(decorators: readonly Decorator[], modifiers: readonly Modifier[], asteriskToken: AsteriskToken, name: string | Identifier, typeParameters: readonly TypeParameterDeclaration[], parameters: readonly ParameterDeclaration[], type: TypeNode, body: Block): FunctionDeclaration

• Parameters

  • decorators: readonly Decorator[]

  • modifiers: readonly Modifier[]

  • asteriskToken: AsteriskToken

  • name: string | Identifier

  • typeParameters: readonly TypeParameterDeclaration[]

  • parameters: readonly ParameterDeclaration[]

  • type: TypeNode

  • body: Block

  Returns FunctionDeclaration

createFunctionExpression

• createFunctionExpression(modifiers: readonly Modifier[], asteriskToken: AsteriskToken, name: string | Identifier, typeParameters: readonly TypeParameterDeclaration[], parameters: readonly ParameterDeclaration[], type: TypeNode, body: Block): FunctionExpression

• Parameters

  • modifiers: readonly Modifier[]

  • asteriskToken: AsteriskToken

  • name: string | Identifier

  • typeParameters: readonly TypeParameterDeclaration[]

  • parameters: readonly ParameterDeclaration[]

  • type: TypeNode

  • body: Block

  Returns FunctionExpression

createFunctionTypeNode

• createFunctionTypeNode(typeParameters: readonly TypeParameterDeclaration[], parameters: readonly ParameterDeclaration[], type: TypeNode): FunctionTypeNode

• Parameters

  • typeParameters: readonly TypeParameterDeclaration[]

  • parameters: readonly ParameterDeclaration[]

  • type: TypeNode

  Returns FunctionTypeNode

createGetAccessorDeclaration

• createGetAccessorDeclaration(decorators: readonly Decorator[], modifiers: readonly Modifier[], name: string | PropertyName, parameters: readonly ParameterDeclaration[], type: TypeNode, body: Block): GetAccessorDeclaration

• Parameters

  • decorators: readonly Decorator[]

  • modifiers: readonly Modifier[]

  • name: string | PropertyName

  • parameters: readonly ParameterDeclaration[]

  • type: TypeNode

  • body: Block

  Returns GetAccessorDeclaration

createGreaterThan

• createGreaterThan(left: Expression, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • right: Expression

  Returns BinaryExpression

createGreaterThanEquals

• createGreaterThanEquals(left: Expression, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • right: Expression

  Returns BinaryExpression

createHeritageClause

• createHeritageClause(token: ExtendsKeyword | ImplementsKeyword, types: readonly ExpressionWithTypeArguments[]): HeritageClause

• Parameters

  • token: ExtendsKeyword | ImplementsKeyword

  • types: readonly ExpressionWithTypeArguments[]

  Returns HeritageClause

createIdentifier

• createIdentifier(text: string): Identifier

• Parameters

  • text: string

  Returns Identifier

createIfStatement

• createIfStatement(expression: Expression, thenStatement: Statement, elseStatement?: Statement): IfStatement

• Parameters

  • expression: Expression

  • thenStatement: Statement

  • Optional elseStatement: Statement

  Returns IfStatement

createImmediatelyInvokedArrowFunction

• createImmediatelyInvokedArrowFunction(statements: readonly Statement[]): CallExpression
• createImmediatelyInvokedArrowFunction(statements: readonly Statement[], param: ParameterDeclaration, paramValue: Expression): CallExpression

• Parameters

  • statements: readonly Statement[]

  Returns CallExpression

• Parameters

  • statements: readonly Statement[]

  • param: ParameterDeclaration

  • paramValue: Expression

  Returns CallExpression

createImmediatelyInvokedFunctionExpression

• createImmediatelyInvokedFunctionExpression(statements: readonly Statement[]): CallExpression
• createImmediatelyInvokedFunctionExpression(statements: readonly Statement[], param: ParameterDeclaration, paramValue: Expression): CallExpression

• Parameters

  • statements: readonly Statement[]

  Returns CallExpression

• Parameters

  • statements: readonly Statement[]

  • param: ParameterDeclaration

  • paramValue: Expression

  Returns CallExpression

createImportClause

• createImportClause(isTypeOnly: boolean, name: Identifier, namedBindings: NamedImportBindings): ImportClause

• Parameters

  • isTypeOnly: boolean

  • name: Identifier

  • namedBindings: NamedImportBindings

  Returns ImportClause

createImportDeclaration

• createImportDeclaration(decorators: readonly Decorator[], modifiers: readonly Modifier[], importClause: ImportClause, moduleSpecifier: Expression): ImportDeclaration

• Parameters

  • decorators: readonly Decorator[]

  • modifiers: readonly Modifier[]

  • importClause: ImportClause

  • moduleSpecifier: Expression

  Returns ImportDeclaration

createImportEqualsDeclaration

• createImportEqualsDeclaration(decorators: readonly Decorator[], modifiers: readonly Modifier[], isTypeOnly: boolean, name: string | Identifier, moduleReference: ModuleReference): ImportEqualsDeclaration

• Parameters

  • decorators: readonly Decorator[]

  • modifiers: readonly Modifier[]

  • isTypeOnly: boolean

  • name: string | Identifier

  • moduleReference: ModuleReference

  Returns ImportEqualsDeclaration

createImportSpecifier

• createImportSpecifier(propertyName: Identifier, name: Identifier): ImportSpecifier

• Parameters

  • propertyName: Identifier

  • name: Identifier

  Returns ImportSpecifier

createImportTypeNode

• createImportTypeNode(argument: TypeNode, qualifier?: EntityName, typeArguments?: readonly TypeNode[], isTypeOf?: boolean): ImportTypeNode

• Parameters

  • argument: TypeNode

  • Optional qualifier: EntityName

  • Optional typeArguments: readonly TypeNode[]

  • Optional isTypeOf: boolean

  Returns ImportTypeNode

createIndexSignature

• createIndexSignature(decorators: readonly Decorator[], modifiers: readonly Modifier[], parameters: readonly ParameterDeclaration[], type: TypeNode): IndexSignatureDeclaration

• Parameters

  • decorators: readonly Decorator[]

  • modifiers: readonly Modifier[]

  • parameters: readonly ParameterDeclaration[]

  • type: TypeNode

  Returns IndexSignatureDeclaration

createIndexedAccessTypeNode

• createIndexedAccessTypeNode(objectType: TypeNode, indexType: TypeNode): IndexedAccessTypeNode

• Parameters

  • objectType: TypeNode

  • indexType: TypeNode

  Returns IndexedAccessTypeNode

createInequality

• createInequality(left: Expression, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • right: Expression

  Returns BinaryExpression

createInferTypeNode

• createInferTypeNode(typeParameter: TypeParameterDeclaration): InferTypeNode

• Parameters

  • typeParameter: TypeParameterDeclaration

  Returns InferTypeNode

createInterfaceDeclaration

• createInterfaceDeclaration(decorators: readonly Decorator[], modifiers: readonly Modifier[], name: string | Identifier, typeParameters: readonly TypeParameterDeclaration[], heritageClauses: readonly HeritageClause[], members: readonly TypeElement[]): InterfaceDeclaration

• Parameters

  • decorators: readonly Decorator[]

  • modifiers: readonly Modifier[]

  • name: string | Identifier

  • typeParameters: readonly TypeParameterDeclaration[]

  • heritageClauses: readonly HeritageClause[]

  • members: readonly TypeElement[]

  Returns InterfaceDeclaration

createIntersectionTypeNode

• createIntersectionTypeNode(types: readonly TypeNode[]): IntersectionTypeNode

• Parameters

  • types: readonly TypeNode[]

  Returns IntersectionTypeNode

createJSDocAllType

• createJSDocAllType(): JSDocAllType

• Returns JSDocAllType

createJSDocAugmentsTag

• createJSDocAugmentsTag(tagName: Identifier, className: ExpressionWithTypeArguments & { expression: Identifier | PropertyAccessEntityNameExpression }, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocAugmentsTag

• Parameters

  • tagName: Identifier

  • className: ExpressionWithTypeArguments & { expression: Identifier | PropertyAccessEntityNameExpression }

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocAugmentsTag

createJSDocAuthorTag

• createJSDocAuthorTag(tagName: Identifier, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocAuthorTag

• Parameters

  • tagName: Identifier

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocAuthorTag

createJSDocCallbackTag

• createJSDocCallbackTag(tagName: Identifier, typeExpression: JSDocSignature, fullName?: Identifier | JSDocNamespaceDeclaration, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocCallbackTag

• Parameters

  • tagName: Identifier

  • typeExpression: JSDocSignature

  • Optional fullName: Identifier | JSDocNamespaceDeclaration

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocCallbackTag

createJSDocClassTag

• createJSDocClassTag(tagName: Identifier, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocClassTag

• Parameters

  • tagName: Identifier

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocClassTag

createJSDocComment

• createJSDocComment(comment?: string | NodeArray<JSDocText | JSDocLink>, tags?: readonly JSDocTag[]): JSDoc

• Parameters

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  • Optional tags: readonly JSDocTag[]

  Returns JSDoc

createJSDocDeprecatedTag

• createJSDocDeprecatedTag(tagName: Identifier, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocDeprecatedTag

• Parameters

  • tagName: Identifier

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocDeprecatedTag

createJSDocEnumTag

• createJSDocEnumTag(tagName: Identifier, typeExpression: JSDocTypeExpression, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocEnumTag

• Parameters

  • tagName: Identifier

  • typeExpression: JSDocTypeExpression

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocEnumTag

createJSDocFunctionType

• createJSDocFunctionType(parameters: readonly ParameterDeclaration[], type: TypeNode): JSDocFunctionType

• Parameters

  • parameters: readonly ParameterDeclaration[]

  • type: TypeNode

  Returns JSDocFunctionType

createJSDocImplementsTag

• createJSDocImplementsTag(tagName: Identifier, className: ExpressionWithTypeArguments & { expression: Identifier | PropertyAccessEntityNameExpression }, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocImplementsTag

• Parameters

  • tagName: Identifier

  • className: ExpressionWithTypeArguments & { expression: Identifier | PropertyAccessEntityNameExpression }

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocImplementsTag

createJSDocLink

• createJSDocLink(name: EntityName, text: string): JSDocLink

• Parameters

  • name: EntityName

  • text: string

  Returns JSDocLink

createJSDocNameReference

• createJSDocNameReference(name: EntityName): JSDocNameReference

• Parameters

  • name: EntityName

  Returns JSDocNameReference

createJSDocNamepathType

• createJSDocNamepathType(type: TypeNode): JSDocNamepathType

• Parameters

  • type: TypeNode

  Returns JSDocNamepathType

createJSDocNonNullableType

• createJSDocNonNullableType(type: TypeNode): JSDocNonNullableType

• Parameters

  • type: TypeNode

  Returns JSDocNonNullableType

createJSDocNullableType

• createJSDocNullableType(type: TypeNode): JSDocNullableType

• Parameters

  • type: TypeNode

  Returns JSDocNullableType

createJSDocOptionalType

• createJSDocOptionalType(type: TypeNode): JSDocOptionalType

• Parameters

  • type: TypeNode

  Returns JSDocOptionalType

createJSDocOverrideTag

• createJSDocOverrideTag(tagName: Identifier, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocOverrideTag

• Parameters

  • tagName: Identifier

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocOverrideTag

createJSDocParameterTag

• createJSDocParameterTag(tagName: Identifier, name: EntityName, isBracketed: boolean, typeExpression?: JSDocTypeExpression, isNameFirst?: boolean, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocParameterTag

• Parameters

  • tagName: Identifier

  • name: EntityName

  • isBracketed: boolean

  • Optional typeExpression: JSDocTypeExpression

  • Optional isNameFirst: boolean

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocParameterTag

createJSDocPrivateTag

• createJSDocPrivateTag(tagName: Identifier, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocPrivateTag

• Parameters

  • tagName: Identifier

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocPrivateTag

createJSDocPropertyTag

• createJSDocPropertyTag(tagName: Identifier, name: EntityName, isBracketed: boolean, typeExpression?: JSDocTypeExpression, isNameFirst?: boolean, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocPropertyTag

• Parameters

  • tagName: Identifier

  • name: EntityName

  • isBracketed: boolean

  • Optional typeExpression: JSDocTypeExpression

  • Optional isNameFirst: boolean

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocPropertyTag

createJSDocProtectedTag

• createJSDocProtectedTag(tagName: Identifier, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocProtectedTag

• Parameters

  • tagName: Identifier

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocProtectedTag

createJSDocPublicTag

• createJSDocPublicTag(tagName: Identifier, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocPublicTag

• Parameters

  • tagName: Identifier

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocPublicTag

createJSDocReadonlyTag

• createJSDocReadonlyTag(tagName: Identifier, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocReadonlyTag

• Parameters

  • tagName: Identifier

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocReadonlyTag

createJSDocReturnTag

• createJSDocReturnTag(tagName: Identifier, typeExpression?: JSDocTypeExpression, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocReturnTag

• Parameters

  • tagName: Identifier

  • Optional typeExpression: JSDocTypeExpression

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocReturnTag

createJSDocSeeTag

• createJSDocSeeTag(tagName: Identifier, nameExpression: JSDocNameReference, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocSeeTag

• Parameters

  • tagName: Identifier

  • nameExpression: JSDocNameReference

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocSeeTag

createJSDocSignature

• createJSDocSignature(typeParameters: readonly JSDocTemplateTag[], parameters: readonly JSDocParameterTag[], type?: JSDocReturnTag): JSDocSignature

• Parameters

  • typeParameters: readonly JSDocTemplateTag[]

  • parameters: readonly JSDocParameterTag[]

  • Optional type: JSDocReturnTag

  Returns JSDocSignature

createJSDocTemplateTag

• createJSDocTemplateTag(tagName: Identifier, constraint: JSDocTypeExpression, typeParameters: readonly TypeParameterDeclaration[], comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocTemplateTag

• Parameters

  • tagName: Identifier

  • constraint: JSDocTypeExpression

  • typeParameters: readonly TypeParameterDeclaration[]

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocTemplateTag

createJSDocText

• createJSDocText(text: string): JSDocText

• Parameters

  • text: string

  Returns JSDocText

createJSDocThisTag

• createJSDocThisTag(tagName: Identifier, typeExpression: JSDocTypeExpression, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocThisTag

• Parameters

  • tagName: Identifier

  • typeExpression: JSDocTypeExpression

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocThisTag

createJSDocTypeExpression

• createJSDocTypeExpression(type: TypeNode): JSDocTypeExpression

• Parameters

  • type: TypeNode

  Returns JSDocTypeExpression

createJSDocTypeLiteral

• createJSDocTypeLiteral(jsDocPropertyTags?: readonly JSDocPropertyLikeTag[], isArrayType?: boolean): JSDocTypeLiteral

• Parameters

  • Optional jsDocPropertyTags: readonly JSDocPropertyLikeTag[]

  • Optional isArrayType: boolean

  Returns JSDocTypeLiteral

createJSDocTypeTag

• createJSDocTypeTag(tagName: Identifier, typeExpression: JSDocTypeExpression, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocTypeTag

• Parameters

  • tagName: Identifier

  • typeExpression: JSDocTypeExpression

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocTypeTag

createJSDocTypedefTag

• createJSDocTypedefTag(tagName: Identifier, typeExpression?: JSDocTypeExpression | JSDocTypeLiteral, fullName?: Identifier | JSDocNamespaceDeclaration, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocTypedefTag

• Parameters

  • tagName: Identifier

  • Optional typeExpression: JSDocTypeExpression | JSDocTypeLiteral

  • Optional fullName: Identifier | JSDocNamespaceDeclaration

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocTypedefTag

createJSDocUnknownTag

• createJSDocUnknownTag(tagName: Identifier, comment?: string | NodeArray<JSDocText | JSDocLink>): JSDocUnknownTag

• Parameters

  • tagName: Identifier

  • Optional comment: string | NodeArray<JSDocText | JSDocLink>

  Returns JSDocUnknownTag

createJSDocUnknownType

• createJSDocUnknownType(): JSDocUnknownType

• Returns JSDocUnknownType

createJSDocVariadicType

• createJSDocVariadicType(type: TypeNode): JSDocVariadicType

• Parameters

  • type: TypeNode

  Returns JSDocVariadicType

createJsxAttribute

• createJsxAttribute(name: Identifier, initializer: StringLiteral | JsxExpression): JsxAttribute

• Parameters

  • name: Identifier

  • initializer: StringLiteral | JsxExpression

  Returns JsxAttribute

createJsxAttributes

• createJsxAttributes(properties: readonly JsxAttributeLike[]): JsxAttributes

• Parameters

  • properties: readonly JsxAttributeLike[]

  Returns JsxAttributes

createJsxClosingElement

• createJsxClosingElement(tagName: JsxTagNameExpression): JsxClosingElement

• Parameters

  • tagName: JsxTagNameExpression

  Returns JsxClosingElement

createJsxElement

• createJsxElement(openingElement: JsxOpeningElement, children: readonly JsxChild[], closingElement: JsxClosingElement): JsxElement

• Parameters

  • openingElement: JsxOpeningElement

  • children: readonly JsxChild[]

  • closingElement: JsxClosingElement

  Returns JsxElement

createJsxExpression

• createJsxExpression(dotDotDotToken: DotDotDotToken, expression: Expression): JsxExpression

• Parameters

  • dotDotDotToken: DotDotDotToken

  • expression: Expression

  Returns JsxExpression

createJsxFragment

• createJsxFragment(openingFragment: JsxOpeningFragment, children: readonly JsxChild[], closingFragment: JsxClosingFragment): JsxFragment

• Parameters

  • openingFragment: JsxOpeningFragment

  • children: readonly JsxChild[]

  • closingFragment: JsxClosingFragment

  Returns JsxFragment

createJsxJsxClosingFragment

• createJsxJsxClosingFragment(): JsxClosingFragment

• Returns JsxClosingFragment

createJsxOpeningElement

• createJsxOpeningElement(tagName: JsxTagNameExpression, typeArguments: readonly TypeNode[], attributes: JsxAttributes): JsxOpeningElement

• Parameters

  • tagName: JsxTagNameExpression

  • typeArguments: readonly TypeNode[]

  • attributes: JsxAttributes

  Returns JsxOpeningElement

createJsxOpeningFragment

• createJsxOpeningFragment(): JsxOpeningFragment

• Returns JsxOpeningFragment

createJsxSelfClosingElement

• createJsxSelfClosingElement(tagName: JsxTagNameExpression, typeArguments: readonly TypeNode[], attributes: JsxAttributes): JsxSelfClosingElement

• Parameters

  • tagName: JsxTagNameExpression

  • typeArguments: readonly TypeNode[]

  • attributes: JsxAttributes

  Returns JsxSelfClosingElement

createJsxSpreadAttribute

• createJsxSpreadAttribute(expression: Expression): JsxSpreadAttribute

• Parameters

  • expression: Expression

  Returns JsxSpreadAttribute

createJsxText

• createJsxText(text: string, containsOnlyTriviaWhiteSpaces?: boolean): JsxText

• Parameters

  • text: string

  • Optional containsOnlyTriviaWhiteSpaces: boolean

  Returns JsxText

createLabeledStatement

• createLabeledStatement(label: string | Identifier, statement: Statement): LabeledStatement

• Parameters

  • label: string | Identifier

  • statement: Statement

  Returns LabeledStatement

createLeftShift

• createLeftShift(left: Expression, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • right: Expression

  Returns BinaryExpression

createLessThan

• createLessThan(left: Expression, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • right: Expression

  Returns BinaryExpression

createLessThanEquals

• createLessThanEquals(left: Expression, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • right: Expression

  Returns BinaryExpression

createLiteralTypeNode

• createLiteralTypeNode(literal: LiteralExpression | NullLiteral | BooleanLiteral | PrefixUnaryExpression): LiteralTypeNode

• Parameters

  • literal: LiteralExpression | NullLiteral | BooleanLiteral | PrefixUnaryExpression

  Returns LiteralTypeNode

createLogicalAnd

• createLogicalAnd(left: Expression, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • right: Expression

  Returns BinaryExpression

createLogicalNot

• createLogicalNot(operand: Expression): PrefixUnaryExpression

• Parameters

  • operand: Expression

  Returns PrefixUnaryExpression

createLogicalOr

• createLogicalOr(left: Expression, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • right: Expression

  Returns BinaryExpression

createLoopVariable

• createLoopVariable(reservedInNestedScopes?: boolean): Identifier

• Create a unique temporary variable for use in a loop.

  Parameters

  • Optional reservedInNestedScopes: boolean

    When true, reserves the temporary variable name in all nested scopes during emit so that the variable can be referenced in a nested function body. This is an alternative to setting EmitFlags.ReuseTempVariableScope on the nested function itself.

  Returns Identifier

createMappedTypeNode

• createMappedTypeNode(readonlyToken: ReadonlyKeyword | PlusToken | MinusToken, typeParameter: TypeParameterDeclaration, nameType: TypeNode, questionToken: QuestionToken | PlusToken | MinusToken, type: TypeNode): MappedTypeNode

• Parameters

  • readonlyToken: ReadonlyKeyword | PlusToken | MinusToken

  • typeParameter: TypeParameterDeclaration

  • nameType: TypeNode

  • questionToken: QuestionToken | PlusToken | MinusToken

  • type: TypeNode

  Returns MappedTypeNode

createMetaProperty

• createMetaProperty(keywordToken: ImportKeyword | NewKeyword, name: Identifier): MetaProperty

• Parameters

  • keywordToken: ImportKeyword | NewKeyword

  • name: Identifier

  Returns MetaProperty

createMethodDeclaration

• createMethodDeclaration(decorators: readonly Decorator[], modifiers: readonly Modifier[], asteriskToken: AsteriskToken, name: string | PropertyName, questionToken: QuestionToken, typeParameters: readonly TypeParameterDeclaration[], parameters: readonly ParameterDeclaration[], type: TypeNode, body: Block): MethodDeclaration

• Parameters

  • decorators: readonly Decorator[]

  • modifiers: readonly Modifier[]

  • asteriskToken: AsteriskToken

  • name: string | PropertyName

  • questionToken: QuestionToken

  • typeParameters: readonly TypeParameterDeclaration[]

  • parameters: readonly ParameterDeclaration[]

  • type: TypeNode

  • body: Block

  Returns MethodDeclaration

createMethodSignature

• createMethodSignature(modifiers: readonly Modifier[], name: string | PropertyName, questionToken: QuestionToken, typeParameters: readonly TypeParameterDeclaration[], parameters: readonly ParameterDeclaration[], type: TypeNode): MethodSignature

• Parameters

  • modifiers: readonly Modifier[]

  • name: string | PropertyName

  • questionToken: QuestionToken

  • typeParameters: readonly TypeParameterDeclaration[]

  • parameters: readonly ParameterDeclaration[]

  • type: TypeNode

  Returns MethodSignature

createModifiersFromModifierFlags

• createModifiersFromModifierFlags(flags: ModifierFlags): Modifier[]

• Parameters

  • flags: ModifierFlags

  Returns Modifier[]

createModuleBlock

• createModuleBlock(statements: readonly Statement[]): ModuleBlock

• Parameters

  • statements: readonly Statement[]

  Returns ModuleBlock

createModuleDeclaration

• createModuleDeclaration(decorators: readonly Decorator[], modifiers: readonly Modifier[], name: ModuleName, body: ModuleBody, flags?: NodeFlags): ModuleDeclaration

• Parameters

  • decorators: readonly Decorator[]

  • modifiers: readonly Modifier[]

  • name: ModuleName

  • body: ModuleBody

  • Optional flags: NodeFlags

  Returns ModuleDeclaration

createModulo

• createModulo(left: Expression, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • right: Expression

  Returns BinaryExpression

createMultiply

• createMultiply(left: Expression, right: Expression): BinaryExpression

• Parameters

  • left: Expression

  • right: Expression

  Returns BinaryExpression

createNamedExports

• createNamedExports(elements: readonly ExportSpecifier[]): NamedExports

• Parameters

  • elements: readonly ExportSpecifier[]

  Returns NamedExports

createNamedImports

• createNamedImports(elements: readonly ImportSpecifier[]): NamedImports

• Parameters

  • elements: readonly ImportSpecifier[]

  Returns NamedImports

createNamedTupleMember

• createNamedTupleMember(dotDotDotToken: DotDotDotToken, name: Identifier, questionToken: QuestionToken, type: TypeNode): NamedTupleMember

• Parameters

  • dotDotDotToken: DotDotDotToken

  • name: Identifier

  • questionToken: QuestionToken

  • type: TypeNode

  Returns NamedTupleMember

createNamespaceExport

• createNamespaceExport(name: Identifier): NamespaceExport

• Parameters

  • name: Identifier

  Returns NamespaceExport

createNamespaceExportDeclaration

• createNamespaceExportDeclaration(name: string | Identifier): NamespaceExportDeclaration

• Parameters

  • name: string | Identifier

  Returns NamespaceExportDeclaration

createNamespaceImport

• createNamespaceImport(name: Identifier): NamespaceImport

• Parameters

  • name: Identifier

  Returns NamespaceImport

createNewExpression

• createNewExpression(expression: Expression, typeArguments: readonly TypeNode[], argumentsArray: readonly Expression[]): NewExpression

• Parameters

  • expression: Expression

  • typeArguments: readonly TypeNode[]

  • argumentsArray: readonly Expression[]

  Returns NewExpression

createNoSubstitutionTemplateLiteral

• createNoSubstitutionTemplateLiteral(text: string, rawText?: string): NoSubstitutionTemplateLiteral
• createNoSubstitutionTemplateLiteral(text: string, rawText: string): NoSubstitutionTemplateLiteral

• Parameters

  • text: string

  • Optional rawText: string

  Returns NoSubstitutionTemplateLiteral

• Parameters

  • text: string

  • rawText: string

  Returns NoSubstitutionTemplateLiteral

createNonNullChain

• createNonNullChain(expression: Expression): NonNullChain

• Parameters

  • expression: Expression

  Returns NonNullChain

createNonNullExpression

• createNonNullExpression(expression: Expression): NonNullExpression

• Parameters

  • expression: Expression

  Returns NonNullExpression

createNotEmittedStatement

• createNotEmittedStatement(original: Node): NotEmittedStatement

• Parameters

  • original: Node

  Returns NotEmittedStatement

createNull

• createNull(): NullLiteral

• Returns NullLiteral

createNumericLiteral

• createNumericLiteral(value: string | number, numericLiteralFlags?: TokenFlags): NumericLiteral