(create-add node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-array-binding-pattern node-factory elements)Parameters:
elements: readonly ArrayBindingElement[]Returns: ArrayBindingPattern
**Parameters:** - `elements`: `readonly ArrayBindingElement[]` **Returns:** `ArrayBindingPattern`
(create-array-literal-expression node-factory)(create-array-literal-expression node-factory elements)(create-array-literal-expression node-factory elements multi-line?)Parameters:
elements: readonly Expression[] | undefinedmulti-line?: boolean | undefinedReturns: ArrayLiteralExpression
**Parameters:** - `elements`: `readonly Expression[] | undefined` - `multi-line?`: `boolean | undefined` **Returns:** `ArrayLiteralExpression`
(create-array-type-node node-factory element-type)Parameters:
element-type: TypeNodeReturns: ArrayTypeNode
**Parameters:** - `element-type`: `TypeNode` **Returns:** `ArrayTypeNode`
(create-arrow-function node-factory)(create-arrow-function node-factory modifiers)(create-arrow-function node-factory modifiers type-parameters)(create-arrow-function node-factory modifiers type-parameters parameters)(create-arrow-function node-factory modifiers type-parameters parameters type)(create-arrow-function node-factory
modifiers
type-parameters
parameters
type
equals-greater-than-token)(create-arrow-function node-factory
modifiers
type-parameters
parameters
type
equals-greater-than-token
body)Parameters:
modifiers: readonly Modifier[] | undefinedtype-parameters: readonly TypeParameterDeclaration[] | undefinedparameters: readonly ParameterDeclaration[]type: TypeNode | undefinedequals-greater-than-token: EqualsGreaterThanToken | undefinedbody: ConciseBodyReturns: ArrowFunction
**Parameters:** - `modifiers`: `readonly Modifier[] | undefined` - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `parameters`: `readonly ParameterDeclaration[]` - `type`: `TypeNode | undefined` - `equals-greater-than-token`: `EqualsGreaterThanToken | undefined` - `body`: `ConciseBody` **Returns:** `ArrowFunction`
(create-as-expression node-factory expression type)Parameters:
expression: Expressiontype: TypeNodeReturns: AsExpression
**Parameters:** - `expression`: `Expression` - `type`: `TypeNode` **Returns:** `AsExpression`
(create-assert-clause node-factory elements)(create-assert-clause node-factory elements multi-line?)Parameters:
elements: NodeArray<AssertEntry>multi-line?: boolean | undefinedReturns: AssertClause
**Parameters:** - `elements`: `NodeArray<AssertEntry>` - `multi-line?`: `boolean | undefined` **Returns:** `AssertClause`
(create-assert-entry node-factory name value)Parameters:
name: ImportAttributeNamevalue: ExpressionReturns: AssertEntry
**Parameters:** - `name`: `ImportAttributeName` - `value`: `Expression` **Returns:** `AssertEntry`
(create-assignment node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: AssignmentExpression<EqualsToken>
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `AssignmentExpression<EqualsToken>`
(create-await-expression node-factory expression)Parameters:
expression: ExpressionReturns: AwaitExpression
**Parameters:** - `expression`: `Expression` **Returns:** `AwaitExpression`
(create-big-int-literal node-factory value)Parameters:
value: string | PseudoBigIntReturns: BigIntLiteral
**Parameters:** - `value`: `string | PseudoBigInt` **Returns:** `BigIntLiteral`
(create-binary-expression node-factory left operator right)Parameters:
left: Expressionoperator: BinaryOperator | BinaryOperatorTokenright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `operator`: `BinaryOperator | BinaryOperatorToken` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-binding-element node-factory)(create-binding-element node-factory dot-dot-dot-token)(create-binding-element node-factory dot-dot-dot-token property-name)(create-binding-element node-factory dot-dot-dot-token property-name name)(create-binding-element node-factory
dot-dot-dot-token
property-name
name
initializer)Parameters:
dot-dot-dot-token: DotDotDotToken | undefinedproperty-name: string | PropertyName | undefinedname: string | BindingNameinitializer: Expression | undefinedReturns: BindingElement
**Parameters:** - `dot-dot-dot-token`: `DotDotDotToken | undefined` - `property-name`: `string | PropertyName | undefined` - `name`: `string | BindingName` - `initializer`: `Expression | undefined` **Returns:** `BindingElement`
(create-bitwise-and node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-bitwise-not node-factory operand)Parameters:
operand: ExpressionReturns: PrefixUnaryExpression
**Parameters:** - `operand`: `Expression` **Returns:** `PrefixUnaryExpression`
(create-bitwise-or node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-bitwise-xor node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-block node-factory statements)(create-block node-factory statements multi-line?)Parameters:
statements: readonly Statement[]multi-line?: boolean | undefinedReturns: Block
**Parameters:** - `statements`: `readonly Statement[]` - `multi-line?`: `boolean | undefined` **Returns:** `Block`
(create-break-statement node-factory)(create-break-statement node-factory label)Parameters:
label: string | Identifier | undefinedReturns: BreakStatement
**Parameters:** - `label`: `string | Identifier | undefined` **Returns:** `BreakStatement`
(create-bundle node-factory source-files)(create-bundle node-factory source-files prepends)Parameters:
source-files: readonly SourceFile[]prepends: readonly (UnparsedSource | InputFiles)[] | undefinedReturns: Bundle
**Parameters:** - `source-files`: `readonly SourceFile[]` - `prepends`: `readonly (UnparsedSource | InputFiles)[] | undefined` **Returns:** `Bundle`
(create-call-chain node-factory expression)(create-call-chain node-factory expression question-dot-token)(create-call-chain node-factory expression question-dot-token type-arguments)(create-call-chain node-factory
expression
question-dot-token
type-arguments
arguments-array)Parameters:
expression: Expressionquestion-dot-token: QuestionDotToken | undefinedtype-arguments: readonly TypeNode[] | undefinedarguments-array: readonly Expression[] | undefinedReturns: CallChain
**Parameters:** - `expression`: `Expression` - `question-dot-token`: `QuestionDotToken | undefined` - `type-arguments`: `readonly TypeNode[] | undefined` - `arguments-array`: `readonly Expression[] | undefined` **Returns:** `CallChain`
(create-call-expression node-factory expression)(create-call-expression node-factory expression type-arguments)(create-call-expression node-factory expression type-arguments arguments-array)Parameters:
expression: Expressiontype-arguments: readonly TypeNode[] | undefinedarguments-array: readonly Expression[] | undefinedReturns: CallExpression
**Parameters:** - `expression`: `Expression` - `type-arguments`: `readonly TypeNode[] | undefined` - `arguments-array`: `readonly Expression[] | undefined` **Returns:** `CallExpression`
(create-call-signature node-factory)(create-call-signature node-factory type-parameters)(create-call-signature node-factory type-parameters parameters)(create-call-signature node-factory type-parameters parameters type)Parameters:
type-parameters: readonly TypeParameterDeclaration[] | undefinedparameters: readonly ParameterDeclaration[]type: TypeNode | undefinedReturns: CallSignatureDeclaration
**Parameters:** - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `parameters`: `readonly ParameterDeclaration[]` - `type`: `TypeNode | undefined` **Returns:** `CallSignatureDeclaration`
(create-case-block node-factory clauses)Parameters:
clauses: readonly CaseOrDefaultClause[]Returns: CaseBlock
**Parameters:** - `clauses`: `readonly CaseOrDefaultClause[]` **Returns:** `CaseBlock`
(create-case-clause node-factory expression statements)Parameters:
expression: Expressionstatements: readonly Statement[]Returns: CaseClause
**Parameters:** - `expression`: `Expression` - `statements`: `readonly Statement[]` **Returns:** `CaseClause`
(create-catch-clause node-factory)(create-catch-clause node-factory variable-declaration)(create-catch-clause node-factory variable-declaration block)Parameters:
variable-declaration: string | VariableDeclaration | BindingName | undefinedblock: BlockReturns: CatchClause
**Parameters:** - `variable-declaration`: `string | VariableDeclaration | BindingName | undefined` - `block`: `Block` **Returns:** `CatchClause`
(create-class-declaration node-factory)(create-class-declaration node-factory modifiers)(create-class-declaration node-factory modifiers name)(create-class-declaration node-factory modifiers name type-parameters)(create-class-declaration node-factory
modifiers
name
type-parameters
heritage-clauses)(create-class-declaration node-factory
modifiers
name
type-parameters
heritage-clauses
members)Parameters:
modifiers: readonly ModifierLike[] | undefinedname: string | Identifier | undefinedtype-parameters: readonly TypeParameterDeclaration[] | undefinedheritage-clauses: readonly HeritageClause[] | undefinedmembers: readonly ClassElement[]Returns: ClassDeclaration
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `name`: `string | Identifier | undefined` - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `heritage-clauses`: `readonly HeritageClause[] | undefined` - `members`: `readonly ClassElement[]` **Returns:** `ClassDeclaration`
(create-class-expression node-factory)(create-class-expression node-factory modifiers)(create-class-expression node-factory modifiers name)(create-class-expression node-factory modifiers name type-parameters)(create-class-expression node-factory
modifiers
name
type-parameters
heritage-clauses)(create-class-expression node-factory
modifiers
name
type-parameters
heritage-clauses
members)Parameters:
modifiers: readonly ModifierLike[] | undefinedname: string | Identifier | undefinedtype-parameters: readonly TypeParameterDeclaration[] | undefinedheritage-clauses: readonly HeritageClause[] | undefinedmembers: readonly ClassElement[]Returns: ClassExpression
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `name`: `string | Identifier | undefined` - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `heritage-clauses`: `readonly HeritageClause[] | undefined` - `members`: `readonly ClassElement[]` **Returns:** `ClassExpression`
(create-class-static-block-declaration node-factory body)Parameters:
body: BlockReturns: ClassStaticBlockDeclaration
**Parameters:** - `body`: `Block` **Returns:** `ClassStaticBlockDeclaration`
(create-comma node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-comma-list-expression node-factory elements)Parameters:
elements: readonly Expression[]Returns: CommaListExpression
**Parameters:** - `elements`: `readonly Expression[]` **Returns:** `CommaListExpression`
(create-computed-property-name node-factory expression)Parameters:
expression: ExpressionReturns: ComputedPropertyName
**Parameters:** - `expression`: `Expression` **Returns:** `ComputedPropertyName`
(create-conditional-expression node-factory condition)(create-conditional-expression node-factory condition question-token)(create-conditional-expression node-factory condition question-token when-true)(create-conditional-expression node-factory
condition
question-token
when-true
colon-token)(create-conditional-expression node-factory
condition
question-token
when-true
colon-token
when-false)Parameters:
condition: Expressionquestion-token: QuestionToken | undefinedwhen-true: Expressioncolon-token: ColonToken | undefinedwhen-false: ExpressionReturns: ConditionalExpression
**Parameters:** - `condition`: `Expression` - `question-token`: `QuestionToken | undefined` - `when-true`: `Expression` - `colon-token`: `ColonToken | undefined` - `when-false`: `Expression` **Returns:** `ConditionalExpression`
(create-conditional-type-node node-factory
check-type
extends-type
true-type
false-type)Parameters:
check-type: TypeNodeextends-type: TypeNodetrue-type: TypeNodefalse-type: TypeNodeReturns: ConditionalTypeNode
**Parameters:** - `check-type`: `TypeNode` - `extends-type`: `TypeNode` - `true-type`: `TypeNode` - `false-type`: `TypeNode` **Returns:** `ConditionalTypeNode`
(create-construct-signature node-factory)(create-construct-signature node-factory type-parameters)(create-construct-signature node-factory type-parameters parameters)(create-construct-signature node-factory type-parameters parameters type)Parameters:
type-parameters: readonly TypeParameterDeclaration[] | undefinedparameters: readonly ParameterDeclaration[]type: TypeNode | undefinedReturns: ConstructSignatureDeclaration
**Parameters:** - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `parameters`: `readonly ParameterDeclaration[]` - `type`: `TypeNode | undefined` **Returns:** `ConstructSignatureDeclaration`
(create-constructor-declaration node-factory)(create-constructor-declaration node-factory modifiers)(create-constructor-declaration node-factory modifiers parameters)(create-constructor-declaration node-factory modifiers parameters body)Parameters:
modifiers: readonly ModifierLike[] | undefinedparameters: readonly ParameterDeclaration[]body: Block | undefinedReturns: ConstructorDeclaration
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `parameters`: `readonly ParameterDeclaration[]` - `body`: `Block | undefined` **Returns:** `ConstructorDeclaration`
(create-constructor-type-node node-factory)(create-constructor-type-node node-factory modifiers)(create-constructor-type-node node-factory modifiers type-parameters)(create-constructor-type-node node-factory modifiers type-parameters parameters)(create-constructor-type-node node-factory
modifiers
type-parameters
parameters
type)Parameters:
modifiers: readonly Modifier[] | undefinedtype-parameters: readonly TypeParameterDeclaration[] | undefinedparameters: readonly ParameterDeclaration[]type: TypeNodeReturns: ConstructorTypeNode
**Parameters:** - `modifiers`: `readonly Modifier[] | undefined` - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `parameters`: `readonly ParameterDeclaration[]` - `type`: `TypeNode` **Returns:** `ConstructorTypeNode`
(create-continue-statement node-factory)(create-continue-statement node-factory label)Parameters:
label: string | Identifier | undefinedReturns: ContinueStatement
**Parameters:** - `label`: `string | Identifier | undefined` **Returns:** `ContinueStatement`
(create-debugger-statement node-factory)Returns: DebuggerStatement
**Returns:** `DebuggerStatement`
(create-decorator node-factory expression)Parameters:
expression: ExpressionReturns: Decorator
**Parameters:** - `expression`: `Expression` **Returns:** `Decorator`
(create-default-clause node-factory statements)Parameters:
statements: readonly Statement[]Returns: DefaultClause
**Parameters:** - `statements`: `readonly Statement[]` **Returns:** `DefaultClause`
(create-delete-expression node-factory expression)Parameters:
expression: ExpressionReturns: DeleteExpression
**Parameters:** - `expression`: `Expression` **Returns:** `DeleteExpression`
(create-divide node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-do-statement node-factory statement expression)Parameters:
statement: Statementexpression: ExpressionReturns: DoStatement
**Parameters:** - `statement`: `Statement` - `expression`: `Expression` **Returns:** `DoStatement`
(create-element-access-chain node-factory expression)(create-element-access-chain node-factory expression question-dot-token)(create-element-access-chain node-factory expression question-dot-token index)Parameters:
expression: Expressionquestion-dot-token: QuestionDotToken | undefinedindex: number | ExpressionReturns: ElementAccessChain
**Parameters:** - `expression`: `Expression` - `question-dot-token`: `QuestionDotToken | undefined` - `index`: `number | Expression` **Returns:** `ElementAccessChain`
(create-element-access-expression node-factory expression index)Parameters:
expression: Expressionindex: number | ExpressionReturns: ElementAccessExpression
**Parameters:** - `expression`: `Expression` - `index`: `number | Expression` **Returns:** `ElementAccessExpression`
(create-empty-statement node-factory)Returns: EmptyStatement
**Returns:** `EmptyStatement`
(create-enum-declaration node-factory)(create-enum-declaration node-factory modifiers)(create-enum-declaration node-factory modifiers name)(create-enum-declaration node-factory modifiers name members)Parameters:
modifiers: readonly ModifierLike[] | undefinedname: string | Identifiermembers: readonly EnumMember[]Returns: EnumDeclaration
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `name`: `string | Identifier` - `members`: `readonly EnumMember[]` **Returns:** `EnumDeclaration`
(create-enum-member node-factory name)(create-enum-member node-factory name initializer)Parameters:
name: string | PropertyNameinitializer: Expression | undefinedReturns: EnumMember
**Parameters:** - `name`: `string | PropertyName` - `initializer`: `Expression | undefined` **Returns:** `EnumMember`
(create-equality node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-exponent node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-export-assignment node-factory)(create-export-assignment node-factory modifiers)(create-export-assignment node-factory modifiers export-equals?)(create-export-assignment node-factory modifiers export-equals? expression)Parameters:
modifiers: readonly ModifierLike[] | undefinedexport-equals?: boolean | undefinedexpression: ExpressionReturns: ExportAssignment
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `export-equals?`: `boolean | undefined` - `expression`: `Expression` **Returns:** `ExportAssignment`
(create-export-declaration node-factory)(create-export-declaration node-factory modifiers)(create-export-declaration node-factory modifiers type-only?)(create-export-declaration node-factory modifiers type-only? export-clause)(create-export-declaration node-factory
modifiers
type-only?
export-clause
module-specifier)(create-export-declaration node-factory
modifiers
type-only?
export-clause
module-specifier
attributes)Parameters:
modifiers: readonly ModifierLike[] | undefinedtype-only?: booleanexport-clause: NamedExportBindings | undefinedmodule-specifier: Expression | undefinedattributes: ImportAttributes | undefinedReturns: ExportDeclaration
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `type-only?`: `boolean` - `export-clause`: `NamedExportBindings | undefined` - `module-specifier`: `Expression | undefined` - `attributes`: `ImportAttributes | undefined` **Returns:** `ExportDeclaration`
(create-export-default node-factory expression)Parameters:
expression: ExpressionReturns: ExportAssignment
**Parameters:** - `expression`: `Expression` **Returns:** `ExportAssignment`
(create-export-specifier node-factory type-only?)(create-export-specifier node-factory type-only? property-name)(create-export-specifier node-factory type-only? property-name name)Parameters:
type-only?: booleanproperty-name: string | Identifier | undefinedname: string | IdentifierReturns: ExportSpecifier
**Parameters:** - `type-only?`: `boolean` - `property-name`: `string | Identifier | undefined` - `name`: `string | Identifier` **Returns:** `ExportSpecifier`
(create-expression-statement node-factory expression)Parameters:
expression: ExpressionReturns: ExpressionStatement
**Parameters:** - `expression`: `Expression` **Returns:** `ExpressionStatement`
(create-expression-with-type-arguments node-factory expression)(create-expression-with-type-arguments node-factory expression type-arguments)Parameters:
expression: Expressiontype-arguments: readonly TypeNode[] | undefinedReturns: ExpressionWithTypeArguments
**Parameters:** - `expression`: `Expression` - `type-arguments`: `readonly TypeNode[] | undefined` **Returns:** `ExpressionWithTypeArguments`
(create-external-module-export node-factory export-name)Parameters:
export-name: IdentifierReturns: ExportDeclaration
**Parameters:** - `export-name`: `Identifier` **Returns:** `ExportDeclaration`
(create-external-module-reference node-factory expression)Parameters:
expression: ExpressionReturns: ExternalModuleReference
**Parameters:** - `expression`: `Expression` **Returns:** `ExternalModuleReference`
(create-false node-factory)Returns: FalseLiteral
**Returns:** `FalseLiteral`
(create-for-in-statement node-factory initializer expression statement)Parameters:
initializer: ForInitializerexpression: Expressionstatement: StatementReturns: ForInStatement
**Parameters:** - `initializer`: `ForInitializer` - `expression`: `Expression` - `statement`: `Statement` **Returns:** `ForInStatement`
(create-for-of-statement node-factory)(create-for-of-statement node-factory await-modifier)(create-for-of-statement node-factory await-modifier initializer)(create-for-of-statement node-factory await-modifier initializer expression)(create-for-of-statement node-factory
await-modifier
initializer
expression
statement)Parameters:
await-modifier: AwaitKeyword | undefinedinitializer: ForInitializerexpression: Expressionstatement: StatementReturns: ForOfStatement
**Parameters:** - `await-modifier`: `AwaitKeyword | undefined` - `initializer`: `ForInitializer` - `expression`: `Expression` - `statement`: `Statement` **Returns:** `ForOfStatement`
(create-for-statement node-factory)(create-for-statement node-factory initializer)(create-for-statement node-factory initializer condition)(create-for-statement node-factory initializer condition incrementor)(create-for-statement node-factory initializer condition incrementor statement)Parameters:
initializer: ForInitializer | undefinedcondition: Expression | undefinedincrementor: Expression | undefinedstatement: StatementReturns: ForStatement
**Parameters:** - `initializer`: `ForInitializer | undefined` - `condition`: `Expression | undefined` - `incrementor`: `Expression | undefined` - `statement`: `Statement` **Returns:** `ForStatement`
(create-function-declaration node-factory)(create-function-declaration node-factory modifiers)(create-function-declaration node-factory modifiers asterisk-token)(create-function-declaration node-factory modifiers asterisk-token name)(create-function-declaration node-factory
modifiers
asterisk-token
name
type-parameters)(create-function-declaration node-factory
modifiers
asterisk-token
name
type-parameters
parameters)(create-function-declaration node-factory
modifiers
asterisk-token
name
type-parameters
parameters
type)(create-function-declaration node-factory
modifiers
asterisk-token
name
type-parameters
parameters
type
body)Parameters:
modifiers: readonly ModifierLike[] | undefinedasterisk-token: AsteriskToken | undefinedname: string | Identifier | undefinedtype-parameters: readonly TypeParameterDeclaration[] | undefinedparameters: readonly ParameterDeclaration[]type: TypeNode | undefinedbody: Block | undefinedReturns: FunctionDeclaration
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `asterisk-token`: `AsteriskToken | undefined` - `name`: `string | Identifier | undefined` - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `parameters`: `readonly ParameterDeclaration[]` - `type`: `TypeNode | undefined` - `body`: `Block | undefined` **Returns:** `FunctionDeclaration`
(create-function-expression node-factory)(create-function-expression node-factory modifiers)(create-function-expression node-factory modifiers asterisk-token)(create-function-expression node-factory modifiers asterisk-token name)(create-function-expression node-factory
modifiers
asterisk-token
name
type-parameters)(create-function-expression node-factory
modifiers
asterisk-token
name
type-parameters
parameters)(create-function-expression node-factory
modifiers
asterisk-token
name
type-parameters
parameters
type)(create-function-expression node-factory
modifiers
asterisk-token
name
type-parameters
parameters
type
body)Parameters:
modifiers: readonly Modifier[] | undefinedasterisk-token: AsteriskToken | undefinedname: string | Identifier | undefinedtype-parameters: readonly TypeParameterDeclaration[] | undefinedparameters: readonly ParameterDeclaration[] | undefinedtype: TypeNode | undefinedbody: BlockReturns: FunctionExpression
**Parameters:** - `modifiers`: `readonly Modifier[] | undefined` - `asterisk-token`: `AsteriskToken | undefined` - `name`: `string | Identifier | undefined` - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `parameters`: `readonly ParameterDeclaration[] | undefined` - `type`: `TypeNode | undefined` - `body`: `Block` **Returns:** `FunctionExpression`
(create-function-type-node node-factory)(create-function-type-node node-factory type-parameters)(create-function-type-node node-factory type-parameters parameters)(create-function-type-node node-factory type-parameters parameters type)Parameters:
type-parameters: readonly TypeParameterDeclaration[] | undefinedparameters: readonly ParameterDeclaration[]type: TypeNodeReturns: FunctionTypeNode
**Parameters:** - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `parameters`: `readonly ParameterDeclaration[]` - `type`: `TypeNode` **Returns:** `FunctionTypeNode`
(create-get-accessor-declaration node-factory)(create-get-accessor-declaration node-factory modifiers)(create-get-accessor-declaration node-factory modifiers name)(create-get-accessor-declaration node-factory modifiers name parameters)(create-get-accessor-declaration node-factory modifiers name parameters type)(create-get-accessor-declaration node-factory
modifiers
name
parameters
type
body)Parameters:
modifiers: readonly ModifierLike[] | undefinedname: string | PropertyNameparameters: readonly ParameterDeclaration[]type: TypeNode | undefinedbody: Block | undefinedReturns: GetAccessorDeclaration
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `name`: `string | PropertyName` - `parameters`: `readonly ParameterDeclaration[]` - `type`: `TypeNode | undefined` - `body`: `Block | undefined` **Returns:** `GetAccessorDeclaration`
(create-greater-than node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-greater-than-equals node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-heritage-clause node-factory token types)Parameters:
token: SyntaxKind.ExtendsKeyword | SyntaxKind.ImplementsKeywordtypes: readonly ExpressionWithTypeArguments[]Returns: HeritageClause
**Parameters:** - `token`: `SyntaxKind.ExtendsKeyword | SyntaxKind.ImplementsKeyword` - `types`: `readonly ExpressionWithTypeArguments[]` **Returns:** `HeritageClause`
(create-identifier node-factory text)Parameters:
text: stringReturns: Identifier
**Parameters:** - `text`: `string` **Returns:** `Identifier`
(create-if-statement node-factory expression then-statement)(create-if-statement node-factory expression then-statement else-statement)Parameters:
expression: Expressionthen-statement: Statementelse-statement: Statement | undefinedReturns: IfStatement
**Parameters:** - `expression`: `Expression` - `then-statement`: `Statement` - `else-statement`: `Statement | undefined` **Returns:** `IfStatement`
(create-immediately-invoked-arrow-function node-factory statements)(create-immediately-invoked-arrow-function node-factory
statements
param
param-value)Parameters:
statements: readonly Statement[]param: ParameterDeclarationparam-value: ExpressionReturns: ImmediatelyInvokedArrowFunction
**Parameters:** - `statements`: `readonly Statement[]` - `param`: `ParameterDeclaration` - `param-value`: `Expression` **Returns:** `ImmediatelyInvokedArrowFunction`
(create-immediately-invoked-function-expression node-factory statements)(create-immediately-invoked-function-expression node-factory
statements
param
param-value)Parameters:
statements: readonly Statement[]param: ParameterDeclarationparam-value: ExpressionReturns: CallExpression
**Parameters:** - `statements`: `readonly Statement[]` - `param`: `ParameterDeclaration` - `param-value`: `Expression` **Returns:** `CallExpression`
(create-import-attribute node-factory name value)Parameters:
name: ImportAttributeNamevalue: ExpressionReturns: ImportAttribute
**Parameters:** - `name`: `ImportAttributeName` - `value`: `Expression` **Returns:** `ImportAttribute`
(create-import-attributes node-factory elements)(create-import-attributes node-factory elements multi-line?)Parameters:
elements: NodeArray<ImportAttribute>multi-line?: boolean | undefinedReturns: ImportAttributes
**Parameters:** - `elements`: `NodeArray<ImportAttribute>` - `multi-line?`: `boolean | undefined` **Returns:** `ImportAttributes`
(create-import-clause node-factory type-only?)(create-import-clause node-factory type-only? name)(create-import-clause node-factory type-only? name named-bindings)Parameters:
type-only?: booleanname: Identifier | undefinednamed-bindings: NamedImportBindings | undefinedReturns: ImportClause
**Parameters:** - `type-only?`: `boolean` - `name`: `Identifier | undefined` - `named-bindings`: `NamedImportBindings | undefined` **Returns:** `ImportClause`
(create-import-declaration node-factory)(create-import-declaration node-factory modifiers)(create-import-declaration node-factory modifiers import-clause)(create-import-declaration node-factory
modifiers
import-clause
module-specifier)(create-import-declaration node-factory
modifiers
import-clause
module-specifier
attributes)Parameters:
modifiers: readonly ModifierLike[] | undefinedimport-clause: ImportClause | undefinedmodule-specifier: Expressionattributes: ImportAttributes | undefinedReturns: ImportDeclaration
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `import-clause`: `ImportClause | undefined` - `module-specifier`: `Expression` - `attributes`: `ImportAttributes | undefined` **Returns:** `ImportDeclaration`
(create-import-equals-declaration node-factory)(create-import-equals-declaration node-factory modifiers)(create-import-equals-declaration node-factory modifiers type-only?)(create-import-equals-declaration node-factory modifiers type-only? name)(create-import-equals-declaration node-factory
modifiers
type-only?
name
module-reference)Parameters:
modifiers: readonly ModifierLike[] | undefinedtype-only?: booleanname: string | Identifiermodule-reference: ModuleReferenceReturns: ImportEqualsDeclaration
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `type-only?`: `boolean` - `name`: `string | Identifier` - `module-reference`: `ModuleReference` **Returns:** `ImportEqualsDeclaration`
(create-import-specifier node-factory type-only?)(create-import-specifier node-factory type-only? property-name)(create-import-specifier node-factory type-only? property-name name)Parameters:
type-only?: booleanproperty-name: Identifier | undefinedname: IdentifierReturns: ImportSpecifier
**Parameters:** - `type-only?`: `boolean` - `property-name`: `Identifier | undefined` - `name`: `Identifier` **Returns:** `ImportSpecifier`
(create-import-type-assertion-container node-factory clause)(create-import-type-assertion-container node-factory clause multi-line?)Parameters:
clause: AssertClausemulti-line?: boolean | undefinedReturns: ImportTypeAssertionContainer
**Parameters:** - `clause`: `AssertClause` - `multi-line?`: `boolean | undefined` **Returns:** `ImportTypeAssertionContainer`
(create-import-type-node node-factory argument)(create-import-type-node node-factory argument attributes)(create-import-type-node node-factory argument attributes qualifier)(create-import-type-node node-factory
argument
attributes
qualifier
type-arguments)(create-import-type-node node-factory
argument
attributes
qualifier
type-arguments
type-of?)Parameters:
argument: TypeNodeattributes: ImportAttributes | undefinedqualifier: EntityName | undefinedtype-arguments: readonly TypeNode[] | undefinedtype-of?: boolean | undefinedReturns: ImportTypeNode
**Parameters:** - `argument`: `TypeNode` - `attributes`: `ImportAttributes | undefined` - `qualifier`: `EntityName | undefined` - `type-arguments`: `readonly TypeNode[] | undefined` - `type-of?`: `boolean | undefined` **Returns:** `ImportTypeNode`
(create-index-signature node-factory)(create-index-signature node-factory modifiers)(create-index-signature node-factory modifiers parameters)(create-index-signature node-factory modifiers parameters type)Parameters:
modifiers: readonly ModifierLike[] | undefinedparameters: readonly ParameterDeclaration[]type: TypeNodeReturns: IndexSignatureDeclaration
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `parameters`: `readonly ParameterDeclaration[]` - `type`: `TypeNode` **Returns:** `IndexSignatureDeclaration`
(create-indexed-access-type-node node-factory object-type index-type)Parameters:
object-type: TypeNodeindex-type: TypeNodeReturns: IndexedAccessTypeNode
**Parameters:** - `object-type`: `TypeNode` - `index-type`: `TypeNode` **Returns:** `IndexedAccessTypeNode`
(create-inequality node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-infer-type-node node-factory type-parameter)Parameters:
type-parameter: TypeParameterDeclarationReturns: InferTypeNode
**Parameters:** - `type-parameter`: `TypeParameterDeclaration` **Returns:** `InferTypeNode`
(create-interface-declaration node-factory)(create-interface-declaration node-factory modifiers)(create-interface-declaration node-factory modifiers name)(create-interface-declaration node-factory modifiers name type-parameters)(create-interface-declaration node-factory
modifiers
name
type-parameters
heritage-clauses)(create-interface-declaration node-factory
modifiers
name
type-parameters
heritage-clauses
members)Parameters:
modifiers: readonly ModifierLike[] | undefinedname: string | Identifiertype-parameters: readonly TypeParameterDeclaration[] | undefinedheritage-clauses: readonly HeritageClause[] | undefinedmembers: readonly TypeElement[]Returns: InterfaceDeclaration
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `name`: `string | Identifier` - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `heritage-clauses`: `readonly HeritageClause[] | undefined` - `members`: `readonly TypeElement[]` **Returns:** `InterfaceDeclaration`
(create-intersection-type-node node-factory types)Parameters:
types: readonly TypeNode[]Returns: IntersectionTypeNode
**Parameters:** - `types`: `readonly TypeNode[]` **Returns:** `IntersectionTypeNode`
(create-js-doc-all-type node-factory)Returns: JSDocAllType
**Returns:** `JSDocAllType`
(create-js-doc-augments-tag node-factory)(create-js-doc-augments-tag node-factory tag-name)(create-js-doc-augments-tag node-factory tag-name class-name)(create-js-doc-augments-tag node-factory tag-name class-name comment)Parameters:
tag-name: Identifier | undefinedclass-name: ExpressionWithTypeArguments & { readonly expression: Identifier | PropertyAccessEntityNameExpression; }comment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocAugmentsTag
**Parameters:**
- `tag-name`: `Identifier | undefined`
- `class-name`: `ExpressionWithTypeArguments & { readonly expression: Identifier | PropertyAccessEntityNameExpression; }`
- `comment`: `string | NodeArray<JSDocComment> | undefined`
**Returns:** `JSDocAugmentsTag`(create-js-doc-author-tag node-factory)(create-js-doc-author-tag node-factory tag-name)(create-js-doc-author-tag node-factory tag-name comment)Parameters:
tag-name: Identifier | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocAuthorTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocAuthorTag`
(create-js-doc-callback-tag node-factory)(create-js-doc-callback-tag node-factory tag-name)(create-js-doc-callback-tag node-factory tag-name type-expression)(create-js-doc-callback-tag node-factory tag-name type-expression full-name)(create-js-doc-callback-tag node-factory
tag-name
type-expression
full-name
comment)Parameters:
tag-name: Identifier | undefinedtype-expression: JSDocSignaturefull-name: Identifier | JSDocNamespaceDeclaration | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocCallbackTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `type-expression`: `JSDocSignature` - `full-name`: `Identifier | JSDocNamespaceDeclaration | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocCallbackTag`
(create-js-doc-class-tag node-factory)(create-js-doc-class-tag node-factory tag-name)(create-js-doc-class-tag node-factory tag-name comment)Parameters:
tag-name: Identifier | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocClassTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocClassTag`
(create-js-doc-comment node-factory)(create-js-doc-comment node-factory comment)(create-js-doc-comment node-factory comment tags)Parameters:
comment: string | NodeArray<JSDocComment> | undefinedtags: readonly JSDocTag[] | undefinedReturns: JSDoc
**Parameters:** - `comment`: `string | NodeArray<JSDocComment> | undefined` - `tags`: `readonly JSDocTag[] | undefined` **Returns:** `JSDoc`
(create-js-doc-deprecated-tag node-factory)(create-js-doc-deprecated-tag node-factory tag-name)(create-js-doc-deprecated-tag node-factory tag-name comment)Parameters:
tag-name: Identifier | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocDeprecatedTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocDeprecatedTag`
(create-js-doc-enum-tag node-factory)(create-js-doc-enum-tag node-factory tag-name)(create-js-doc-enum-tag node-factory tag-name type-expression)(create-js-doc-enum-tag node-factory tag-name type-expression comment)Parameters:
tag-name: Identifier | undefinedtype-expression: JSDocTypeExpressioncomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocEnumTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `type-expression`: `JSDocTypeExpression` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocEnumTag`
(create-js-doc-function-type node-factory parameters)(create-js-doc-function-type node-factory parameters type)Parameters:
parameters: readonly ParameterDeclaration[]type: TypeNode | undefinedReturns: JSDocFunctionType
**Parameters:** - `parameters`: `readonly ParameterDeclaration[]` - `type`: `TypeNode | undefined` **Returns:** `JSDocFunctionType`
(create-js-doc-implements-tag node-factory)(create-js-doc-implements-tag node-factory tag-name)(create-js-doc-implements-tag node-factory tag-name class-name)(create-js-doc-implements-tag node-factory tag-name class-name comment)Parameters:
tag-name: Identifier | undefinedclass-name: ExpressionWithTypeArguments & { readonly expression: Identifier | PropertyAccessEntityNameExpression; }comment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocImplementsTag
**Parameters:**
- `tag-name`: `Identifier | undefined`
- `class-name`: `ExpressionWithTypeArguments & { readonly expression: Identifier | PropertyAccessEntityNameExpression; }`
- `comment`: `string | NodeArray<JSDocComment> | undefined`
**Returns:** `JSDocImplementsTag`(create-js-doc-link node-factory)(create-js-doc-link node-factory name)(create-js-doc-link node-factory name text)Parameters:
name: EntityName | JSDocMemberName | undefinedtext: stringReturns: JSDocLink
**Parameters:** - `name`: `EntityName | JSDocMemberName | undefined` - `text`: `string` **Returns:** `JSDocLink`
(create-js-doc-link-code node-factory)(create-js-doc-link-code node-factory name)(create-js-doc-link-code node-factory name text)Parameters:
name: EntityName | JSDocMemberName | undefinedtext: stringReturns: JSDocLinkCode
**Parameters:** - `name`: `EntityName | JSDocMemberName | undefined` - `text`: `string` **Returns:** `JSDocLinkCode`
(create-js-doc-link-plain node-factory)(create-js-doc-link-plain node-factory name)(create-js-doc-link-plain node-factory name text)Parameters:
name: EntityName | JSDocMemberName | undefinedtext: stringReturns: JSDocLinkPlain
**Parameters:** - `name`: `EntityName | JSDocMemberName | undefined` - `text`: `string` **Returns:** `JSDocLinkPlain`
(create-js-doc-member-name node-factory left right)Parameters:
left: EntityName | JSDocMemberNameright: IdentifierReturns: JSDocMemberName
**Parameters:** - `left`: `EntityName | JSDocMemberName` - `right`: `Identifier` **Returns:** `JSDocMemberName`
(create-js-doc-name-reference node-factory name)Parameters:
name: EntityName | JSDocMemberNameReturns: JSDocNameReference
**Parameters:** - `name`: `EntityName | JSDocMemberName` **Returns:** `JSDocNameReference`
(create-js-doc-namepath-type node-factory type)Parameters:
type: TypeNodeReturns: JSDocNamepathType
**Parameters:** - `type`: `TypeNode` **Returns:** `JSDocNamepathType`
(create-js-doc-non-nullable-type node-factory type)(create-js-doc-non-nullable-type node-factory type postfix?)Parameters:
type: TypeNodepostfix?: boolean | undefinedReturns: JSDocNonNullableType
**Parameters:** - `type`: `TypeNode` - `postfix?`: `boolean | undefined` **Returns:** `JSDocNonNullableType`
(create-js-doc-nullable-type node-factory type)(create-js-doc-nullable-type node-factory type postfix?)Parameters:
type: TypeNodepostfix?: boolean | undefinedReturns: JSDocNullableType
**Parameters:** - `type`: `TypeNode` - `postfix?`: `boolean | undefined` **Returns:** `JSDocNullableType`
(create-js-doc-optional-type node-factory type)Parameters:
type: TypeNodeReturns: JSDocOptionalType
**Parameters:** - `type`: `TypeNode` **Returns:** `JSDocOptionalType`
(create-js-doc-overload-tag node-factory)(create-js-doc-overload-tag node-factory tag-name)(create-js-doc-overload-tag node-factory tag-name type-expression)(create-js-doc-overload-tag node-factory tag-name type-expression comment)Parameters:
tag-name: Identifier | undefinedtype-expression: JSDocSignaturecomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocOverloadTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `type-expression`: `JSDocSignature` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocOverloadTag`
(create-js-doc-override-tag node-factory)(create-js-doc-override-tag node-factory tag-name)(create-js-doc-override-tag node-factory tag-name comment)Parameters:
tag-name: Identifier | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocOverrideTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocOverrideTag`
(create-js-doc-parameter-tag node-factory)(create-js-doc-parameter-tag node-factory tag-name)(create-js-doc-parameter-tag node-factory tag-name name)(create-js-doc-parameter-tag node-factory tag-name name bracketed?)(create-js-doc-parameter-tag node-factory
tag-name
name
bracketed?
type-expression)(create-js-doc-parameter-tag node-factory
tag-name
name
bracketed?
type-expression
name-first?)(create-js-doc-parameter-tag node-factory
tag-name
name
bracketed?
type-expression
name-first?
comment)Parameters:
tag-name: Identifier | undefinedname: EntityNamebracketed?: booleantype-expression: JSDocTypeExpression | undefinedname-first?: boolean | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocParameterTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `name`: `EntityName` - `bracketed?`: `boolean` - `type-expression`: `JSDocTypeExpression | undefined` - `name-first?`: `boolean | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocParameterTag`
(create-js-doc-private-tag node-factory)(create-js-doc-private-tag node-factory tag-name)(create-js-doc-private-tag node-factory tag-name comment)Parameters:
tag-name: Identifier | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocPrivateTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocPrivateTag`
(create-js-doc-property-tag node-factory)(create-js-doc-property-tag node-factory tag-name)(create-js-doc-property-tag node-factory tag-name name)(create-js-doc-property-tag node-factory tag-name name bracketed?)(create-js-doc-property-tag node-factory
tag-name
name
bracketed?
type-expression)(create-js-doc-property-tag node-factory
tag-name
name
bracketed?
type-expression
name-first?)(create-js-doc-property-tag node-factory
tag-name
name
bracketed?
type-expression
name-first?
comment)Parameters:
tag-name: Identifier | undefinedname: EntityNamebracketed?: booleantype-expression: JSDocTypeExpression | undefinedname-first?: boolean | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocPropertyTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `name`: `EntityName` - `bracketed?`: `boolean` - `type-expression`: `JSDocTypeExpression | undefined` - `name-first?`: `boolean | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocPropertyTag`
(create-js-doc-protected-tag node-factory)(create-js-doc-protected-tag node-factory tag-name)(create-js-doc-protected-tag node-factory tag-name comment)Parameters:
tag-name: Identifier | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocProtectedTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocProtectedTag`
(create-js-doc-public-tag node-factory)(create-js-doc-public-tag node-factory tag-name)(create-js-doc-public-tag node-factory tag-name comment)Parameters:
tag-name: Identifier | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocPublicTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocPublicTag`
(create-js-doc-readonly-tag node-factory)(create-js-doc-readonly-tag node-factory tag-name)(create-js-doc-readonly-tag node-factory tag-name comment)Parameters:
tag-name: Identifier | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocReadonlyTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocReadonlyTag`
(create-js-doc-return-tag node-factory)(create-js-doc-return-tag node-factory tag-name)(create-js-doc-return-tag node-factory tag-name type-expression)(create-js-doc-return-tag node-factory tag-name type-expression comment)Parameters:
tag-name: Identifier | undefinedtype-expression: JSDocTypeExpression | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocReturnTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `type-expression`: `JSDocTypeExpression | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocReturnTag`
(create-js-doc-satisfies-tag node-factory)(create-js-doc-satisfies-tag node-factory tag-name)(create-js-doc-satisfies-tag node-factory tag-name type-expression)(create-js-doc-satisfies-tag node-factory tag-name type-expression comment)Parameters:
tag-name: Identifier | undefinedtype-expression: JSDocTypeExpressioncomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocSatisfiesTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `type-expression`: `JSDocTypeExpression` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocSatisfiesTag`
(create-js-doc-see-tag node-factory)(create-js-doc-see-tag node-factory tag-name)(create-js-doc-see-tag node-factory tag-name name-expression)(create-js-doc-see-tag node-factory tag-name name-expression comment)Parameters:
tag-name: Identifier | undefinedname-expression: JSDocNameReference | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocSeeTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `name-expression`: `JSDocNameReference | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocSeeTag`
(create-js-doc-signature node-factory)(create-js-doc-signature node-factory type-parameters)(create-js-doc-signature node-factory type-parameters parameters)(create-js-doc-signature node-factory type-parameters parameters type)Parameters:
type-parameters: readonly JSDocTemplateTag[] | undefinedparameters: readonly JSDocParameterTag[]type: JSDocReturnTag | undefinedReturns: JSDocSignature
**Parameters:** - `type-parameters`: `readonly JSDocTemplateTag[] | undefined` - `parameters`: `readonly JSDocParameterTag[]` - `type`: `JSDocReturnTag | undefined` **Returns:** `JSDocSignature`
(create-js-doc-template-tag node-factory)(create-js-doc-template-tag node-factory tag-name)(create-js-doc-template-tag node-factory tag-name constraint)(create-js-doc-template-tag node-factory tag-name constraint type-parameters)(create-js-doc-template-tag node-factory
tag-name
constraint
type-parameters
comment)Parameters:
tag-name: Identifier | undefinedconstraint: JSDocTypeExpression | undefinedtype-parameters: readonly TypeParameterDeclaration[]comment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocTemplateTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `constraint`: `JSDocTypeExpression | undefined` - `type-parameters`: `readonly TypeParameterDeclaration[]` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocTemplateTag`
(create-js-doc-text node-factory text)Parameters:
text: stringReturns: JSDocText
**Parameters:** - `text`: `string` **Returns:** `JSDocText`
(create-js-doc-this-tag node-factory)(create-js-doc-this-tag node-factory tag-name)(create-js-doc-this-tag node-factory tag-name type-expression)(create-js-doc-this-tag node-factory tag-name type-expression comment)Parameters:
tag-name: Identifier | undefinedtype-expression: JSDocTypeExpressioncomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocThisTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `type-expression`: `JSDocTypeExpression` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocThisTag`
(create-js-doc-throws-tag node-factory tag-name)(create-js-doc-throws-tag node-factory tag-name type-expression)(create-js-doc-throws-tag node-factory tag-name type-expression comment)Parameters:
tag-name: Identifiertype-expression: JSDocTypeExpression | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocThrowsTag
**Parameters:** - `tag-name`: `Identifier` - `type-expression`: `JSDocTypeExpression | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocThrowsTag`
(create-js-doc-type-expression node-factory type)Parameters:
type: TypeNodeReturns: JSDocTypeExpression
**Parameters:** - `type`: `TypeNode` **Returns:** `JSDocTypeExpression`
(create-js-doc-type-literal node-factory)(create-js-doc-type-literal node-factory js-doc-property-tags)(create-js-doc-type-literal node-factory js-doc-property-tags array-type?)Parameters:
js-doc-property-tags: readonly JSDocPropertyLikeTag[] | undefinedarray-type?: boolean | undefinedReturns: JSDocTypeLiteral
**Parameters:** - `js-doc-property-tags`: `readonly JSDocPropertyLikeTag[] | undefined` - `array-type?`: `boolean | undefined` **Returns:** `JSDocTypeLiteral`
(create-js-doc-type-tag node-factory)(create-js-doc-type-tag node-factory tag-name)(create-js-doc-type-tag node-factory tag-name type-expression)(create-js-doc-type-tag node-factory tag-name type-expression comment)Parameters:
tag-name: Identifier | undefinedtype-expression: JSDocTypeExpressioncomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocTypeTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `type-expression`: `JSDocTypeExpression` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocTypeTag`
(create-js-doc-typedef-tag node-factory)(create-js-doc-typedef-tag node-factory tag-name)(create-js-doc-typedef-tag node-factory tag-name type-expression)(create-js-doc-typedef-tag node-factory tag-name type-expression full-name)(create-js-doc-typedef-tag node-factory
tag-name
type-expression
full-name
comment)Parameters:
tag-name: Identifier | undefinedtype-expression: JSDocTypeExpression | JSDocTypeLiteral | undefinedfull-name: Identifier | JSDocNamespaceDeclaration | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocTypedefTag
**Parameters:** - `tag-name`: `Identifier | undefined` - `type-expression`: `JSDocTypeExpression | JSDocTypeLiteral | undefined` - `full-name`: `Identifier | JSDocNamespaceDeclaration | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocTypedefTag`
(create-js-doc-unknown-tag node-factory tag-name)(create-js-doc-unknown-tag node-factory tag-name comment)Parameters:
tag-name: Identifiercomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocUnknownTag
**Parameters:** - `tag-name`: `Identifier` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocUnknownTag`
(create-js-doc-unknown-type node-factory)Returns: JSDocUnknownType
**Returns:** `JSDocUnknownType`
(create-js-doc-variadic-type node-factory type)Parameters:
type: TypeNodeReturns: JSDocVariadicType
**Parameters:** - `type`: `TypeNode` **Returns:** `JSDocVariadicType`
(create-jsx-attribute node-factory name)(create-jsx-attribute node-factory name initializer)Parameters:
name: JsxAttributeNameinitializer: JsxAttributeValue | undefinedReturns: JsxAttribute
**Parameters:** - `name`: `JsxAttributeName` - `initializer`: `JsxAttributeValue | undefined` **Returns:** `JsxAttribute`
(create-jsx-attributes node-factory properties)Parameters:
properties: readonly JsxAttributeLike[]Returns: JsxAttributes
**Parameters:** - `properties`: `readonly JsxAttributeLike[]` **Returns:** `JsxAttributes`
(create-jsx-closing-element node-factory tag-name)Parameters:
tag-name: JsxTagNameExpressionReturns: JsxClosingElement
**Parameters:** - `tag-name`: `JsxTagNameExpression` **Returns:** `JsxClosingElement`
(create-jsx-element node-factory opening-element children closing-element)Parameters:
opening-element: JsxOpeningElementchildren: readonly JsxChild[]closing-element: JsxClosingElementReturns: JsxElement
**Parameters:** - `opening-element`: `JsxOpeningElement` - `children`: `readonly JsxChild[]` - `closing-element`: `JsxClosingElement` **Returns:** `JsxElement`
(create-jsx-expression node-factory)(create-jsx-expression node-factory dot-dot-dot-token)(create-jsx-expression node-factory dot-dot-dot-token expression)Parameters:
dot-dot-dot-token: DotDotDotToken | undefinedexpression: Expression | undefinedReturns: JsxExpression
**Parameters:** - `dot-dot-dot-token`: `DotDotDotToken | undefined` - `expression`: `Expression | undefined` **Returns:** `JsxExpression`
(create-jsx-fragment node-factory opening-fragment children closing-fragment)Parameters:
opening-fragment: JsxOpeningFragmentchildren: readonly JsxChild[]closing-fragment: JsxClosingFragmentReturns: JsxFragment
**Parameters:** - `opening-fragment`: `JsxOpeningFragment` - `children`: `readonly JsxChild[]` - `closing-fragment`: `JsxClosingFragment` **Returns:** `JsxFragment`
(create-jsx-jsx-closing-fragment node-factory)Returns: JsxClosingFragment
**Returns:** `JsxClosingFragment`
(create-jsx-namespaced-name node-factory namespace name)Parameters:
namespace: Identifiername: IdentifierReturns: JsxNamespacedName
**Parameters:** - `namespace`: `Identifier` - `name`: `Identifier` **Returns:** `JsxNamespacedName`
(create-jsx-opening-element node-factory tag-name)(create-jsx-opening-element node-factory tag-name type-arguments)(create-jsx-opening-element node-factory tag-name type-arguments attributes)Parameters:
tag-name: JsxTagNameExpressiontype-arguments: readonly TypeNode[] | undefinedattributes: JsxAttributesReturns: JsxOpeningElement
**Parameters:** - `tag-name`: `JsxTagNameExpression` - `type-arguments`: `readonly TypeNode[] | undefined` - `attributes`: `JsxAttributes` **Returns:** `JsxOpeningElement`
(create-jsx-opening-fragment node-factory)Returns: JsxOpeningFragment
**Returns:** `JsxOpeningFragment`
(create-jsx-self-closing-element node-factory tag-name)(create-jsx-self-closing-element node-factory tag-name type-arguments)(create-jsx-self-closing-element node-factory
tag-name
type-arguments
attributes)Parameters:
tag-name: JsxTagNameExpressiontype-arguments: readonly TypeNode[] | undefinedattributes: JsxAttributesReturns: JsxSelfClosingElement
**Parameters:** - `tag-name`: `JsxTagNameExpression` - `type-arguments`: `readonly TypeNode[] | undefined` - `attributes`: `JsxAttributes` **Returns:** `JsxSelfClosingElement`
(create-jsx-spread-attribute node-factory expression)Parameters:
expression: ExpressionReturns: JsxSpreadAttribute
**Parameters:** - `expression`: `Expression` **Returns:** `JsxSpreadAttribute`
(create-jsx-text node-factory text)(create-jsx-text node-factory text contains-only-trivia-white-spaces?)Parameters:
text: stringcontains-only-trivia-white-spaces?: boolean | undefinedReturns: JsxText
**Parameters:** - `text`: `string` - `contains-only-trivia-white-spaces?`: `boolean | undefined` **Returns:** `JsxText`
(create-keyword-type-node node-factory kind)Parameters:
kind: TKindReturns: KeywordTypeNode<TKind>
**Parameters:** - `kind`: `TKind` **Returns:** `KeywordTypeNode<TKind>`
(create-labeled-statement node-factory label statement)Parameters:
label: string | Identifierstatement: StatementReturns: LabeledStatement
**Parameters:** - `label`: `string | Identifier` - `statement`: `Statement` **Returns:** `LabeledStatement`
(create-left-shift node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-less-than node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-less-than-equals node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-literal-type-node node-factory literal)Parameters:
literal: LiteralExpression | NullLiteral | BooleanLiteral | PrefixUnaryExpressionReturns: LiteralTypeNode
**Parameters:** - `literal`: `LiteralExpression | NullLiteral | BooleanLiteral | PrefixUnaryExpression` **Returns:** `LiteralTypeNode`
(create-logical-and node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-logical-not node-factory operand)Parameters:
operand: ExpressionReturns: PrefixUnaryExpression
**Parameters:** - `operand`: `Expression` **Returns:** `PrefixUnaryExpression`
(create-logical-or node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-loop-variable node-factory)(create-loop-variable node-factory reserved-in-nested-scopes?)Create a unique temporary variable for use in a loop.
Parameters:
reserved-in-nested-scopes?: boolean | undefined - 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
Create a unique temporary variable for use in a loop. **Parameters:** - `reserved-in-nested-scopes?`: `boolean | undefined` - 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`
(create-mapped-type-node node-factory)(create-mapped-type-node node-factory readonly-token)(create-mapped-type-node node-factory readonly-token type-parameter)(create-mapped-type-node node-factory readonly-token type-parameter name-type)(create-mapped-type-node node-factory
readonly-token
type-parameter
name-type
question-token)(create-mapped-type-node node-factory
readonly-token
type-parameter
name-type
question-token
type)(create-mapped-type-node node-factory
readonly-token
type-parameter
name-type
question-token
type
members)Parameters:
readonly-token: ReadonlyKeyword | PlusToken | MinusToken | undefinedtype-parameter: TypeParameterDeclarationname-type: TypeNode | undefinedquestion-token: QuestionToken | PlusToken | MinusToken | undefinedtype: TypeNode | undefinedmembers: NodeArray<TypeElement> | undefinedReturns: MappedTypeNode
**Parameters:** - `readonly-token`: `ReadonlyKeyword | PlusToken | MinusToken | undefined` - `type-parameter`: `TypeParameterDeclaration` - `name-type`: `TypeNode | undefined` - `question-token`: `QuestionToken | PlusToken | MinusToken | undefined` - `type`: `TypeNode | undefined` - `members`: `NodeArray<TypeElement> | undefined` **Returns:** `MappedTypeNode`
(create-meta-property node-factory keyword-token name)Parameters:
keyword-token: SyntaxKind.ImportKeyword | SyntaxKind.NewKeywordname: IdentifierReturns: MetaProperty
**Parameters:** - `keyword-token`: `SyntaxKind.ImportKeyword | SyntaxKind.NewKeyword` - `name`: `Identifier` **Returns:** `MetaProperty`
(create-method-declaration node-factory)(create-method-declaration node-factory modifiers)(create-method-declaration node-factory modifiers asterisk-token)(create-method-declaration node-factory modifiers asterisk-token name)(create-method-declaration node-factory
modifiers
asterisk-token
name
question-token)(create-method-declaration node-factory
modifiers
asterisk-token
name
question-token
type-parameters)(create-method-declaration node-factory
modifiers
asterisk-token
name
question-token
type-parameters
parameters)(create-method-declaration node-factory
modifiers
asterisk-token
name
question-token
type-parameters
parameters
type)(create-method-declaration node-factory
modifiers
asterisk-token
name
question-token
type-parameters
parameters
type
body)Parameters:
modifiers: readonly ModifierLike[] | undefinedasterisk-token: AsteriskToken | undefinedname: string | PropertyNamequestion-token: QuestionToken | undefinedtype-parameters: readonly TypeParameterDeclaration[] | undefinedparameters: readonly ParameterDeclaration[]type: TypeNode | undefinedbody: Block | undefinedReturns: MethodDeclaration
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `asterisk-token`: `AsteriskToken | undefined` - `name`: `string | PropertyName` - `question-token`: `QuestionToken | undefined` - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `parameters`: `readonly ParameterDeclaration[]` - `type`: `TypeNode | undefined` - `body`: `Block | undefined` **Returns:** `MethodDeclaration`
(create-method-signature node-factory)(create-method-signature node-factory modifiers)(create-method-signature node-factory modifiers name)(create-method-signature node-factory modifiers name question-token)(create-method-signature node-factory
modifiers
name
question-token
type-parameters)(create-method-signature node-factory
modifiers
name
question-token
type-parameters
parameters)(create-method-signature node-factory
modifiers
name
question-token
type-parameters
parameters
type)Parameters:
modifiers: readonly Modifier[] | undefinedname: string | PropertyNamequestion-token: QuestionToken | undefinedtype-parameters: readonly TypeParameterDeclaration[] | undefinedparameters: readonly ParameterDeclaration[]type: TypeNode | undefinedReturns: MethodSignature
**Parameters:** - `modifiers`: `readonly Modifier[] | undefined` - `name`: `string | PropertyName` - `question-token`: `QuestionToken | undefined` - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `parameters`: `readonly ParameterDeclaration[]` - `type`: `TypeNode | undefined` **Returns:** `MethodSignature`
(create-modifier node-factory kind)Parameters:
kind: TReturns: ModifierToken<T>
**Parameters:** - `kind`: `T` **Returns:** `ModifierToken<T>`
(create-modifiers-from-modifier-flags node-factory flags)Parameters:
flags: ModifierFlagsReturns: Modifier[] | undefined
**Parameters:** - `flags`: `ModifierFlags` **Returns:** `Modifier[] | undefined`
(create-module-block node-factory statements)Parameters:
statements: readonly Statement[]Returns: ModuleBlock
**Parameters:** - `statements`: `readonly Statement[]` **Returns:** `ModuleBlock`
(create-module-declaration node-factory)(create-module-declaration node-factory modifiers)(create-module-declaration node-factory modifiers name)(create-module-declaration node-factory modifiers name body)(create-module-declaration node-factory modifiers name body flags)Parameters:
modifiers: readonly ModifierLike[] | undefinedname: ModuleNamebody: ModuleBody | undefinedflags: NodeFlags | undefinedReturns: ModuleDeclaration
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `name`: `ModuleName` - `body`: `ModuleBody | undefined` - `flags`: `NodeFlags | undefined` **Returns:** `ModuleDeclaration`
(create-modulo node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-multiply node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-named-exports node-factory elements)Parameters:
elements: readonly ExportSpecifier[]Returns: NamedExports
**Parameters:** - `elements`: `readonly ExportSpecifier[]` **Returns:** `NamedExports`
(create-named-imports node-factory elements)Parameters:
elements: readonly ImportSpecifier[]Returns: NamedImports
**Parameters:** - `elements`: `readonly ImportSpecifier[]` **Returns:** `NamedImports`
(create-named-tuple-member node-factory)(create-named-tuple-member node-factory dot-dot-dot-token)(create-named-tuple-member node-factory dot-dot-dot-token name)(create-named-tuple-member node-factory dot-dot-dot-token name question-token)(create-named-tuple-member node-factory
dot-dot-dot-token
name
question-token
type)Parameters:
dot-dot-dot-token: DotDotDotToken | undefinedname: Identifierquestion-token: QuestionToken | undefinedtype: TypeNodeReturns: NamedTupleMember
**Parameters:** - `dot-dot-dot-token`: `DotDotDotToken | undefined` - `name`: `Identifier` - `question-token`: `QuestionToken | undefined` - `type`: `TypeNode` **Returns:** `NamedTupleMember`
(create-namespace-export node-factory name)Parameters:
name: IdentifierReturns: NamespaceExport
**Parameters:** - `name`: `Identifier` **Returns:** `NamespaceExport`
(create-namespace-export-declaration node-factory name)Parameters:
name: string | IdentifierReturns: NamespaceExportDeclaration
**Parameters:** - `name`: `string | Identifier` **Returns:** `NamespaceExportDeclaration`
(create-namespace-import node-factory name)Parameters:
name: IdentifierReturns: NamespaceImport
**Parameters:** - `name`: `Identifier` **Returns:** `NamespaceImport`
(create-new-expression node-factory expression)(create-new-expression node-factory expression type-arguments)(create-new-expression node-factory expression type-arguments arguments-array)Parameters:
expression: Expressiontype-arguments: readonly TypeNode[] | undefinedarguments-array: readonly Expression[] | undefinedReturns: NewExpression
**Parameters:** - `expression`: `Expression` - `type-arguments`: `readonly TypeNode[] | undefined` - `arguments-array`: `readonly Expression[] | undefined` **Returns:** `NewExpression`
(create-no-substitution-template-literal node-factory)(create-no-substitution-template-literal node-factory text)(create-no-substitution-template-literal node-factory text raw-text)Parameters:
text: string | undefinedraw-text: stringReturns: NoSubstitutionTemplateLiteral
**Parameters:** - `text`: `string | undefined` - `raw-text`: `string` **Returns:** `NoSubstitutionTemplateLiteral`
(create-node-array node-factory)(create-node-array node-factory elements)(create-node-array node-factory elements has-trailing-comma?)Parameters:
elements: readonly T[] | undefinedhas-trailing-comma?: boolean | undefinedReturns: NodeArray<T>
**Parameters:** - `elements`: `readonly T[] | undefined` - `has-trailing-comma?`: `boolean | undefined` **Returns:** `NodeArray<T>`
(create-non-null-chain node-factory expression)Parameters:
expression: ExpressionReturns: NonNullChain
**Parameters:** - `expression`: `Expression` **Returns:** `NonNullChain`
(create-non-null-expression node-factory expression)Parameters:
expression: ExpressionReturns: NonNullExpression
**Parameters:** - `expression`: `Expression` **Returns:** `NonNullExpression`
(create-not-emitted-statement node-factory original)Parameters:
original: NodeReturns: NotEmittedStatement
**Parameters:** - `original`: `Node` **Returns:** `NotEmittedStatement`
(create-null node-factory)Returns: NullLiteral
**Returns:** `NullLiteral`
(create-numeric-literal node-factory value)(create-numeric-literal node-factory value numeric-literal-flags)Parameters:
value: string | numbernumeric-literal-flags: TokenFlags | undefinedReturns: NumericLiteral
**Parameters:** - `value`: `string | number` - `numeric-literal-flags`: `TokenFlags | undefined` **Returns:** `NumericLiteral`
(create-object-binding-pattern node-factory elements)Parameters:
elements: readonly BindingElement[]Returns: ObjectBindingPattern
**Parameters:** - `elements`: `readonly BindingElement[]` **Returns:** `ObjectBindingPattern`
(create-object-literal-expression node-factory)(create-object-literal-expression node-factory properties)(create-object-literal-expression node-factory properties multi-line?)Parameters:
properties: readonly ObjectLiteralElementLike[] | undefinedmulti-line?: boolean | undefinedReturns: ObjectLiteralExpression
**Parameters:** - `properties`: `readonly ObjectLiteralElementLike[] | undefined` - `multi-line?`: `boolean | undefined` **Returns:** `ObjectLiteralExpression`
(create-omitted-expression node-factory)Returns: OmittedExpression
**Returns:** `OmittedExpression`
(create-optional-type-node node-factory type)Parameters:
type: TypeNodeReturns: OptionalTypeNode
**Parameters:** - `type`: `TypeNode` **Returns:** `OptionalTypeNode`
(create-parameter-declaration node-factory)(create-parameter-declaration node-factory modifiers)(create-parameter-declaration node-factory modifiers dot-dot-dot-token)(create-parameter-declaration node-factory modifiers dot-dot-dot-token name)(create-parameter-declaration node-factory
modifiers
dot-dot-dot-token
name
question-token)(create-parameter-declaration node-factory
modifiers
dot-dot-dot-token
name
question-token
type)(create-parameter-declaration node-factory
modifiers
dot-dot-dot-token
name
question-token
type
initializer)Parameters:
modifiers: readonly ModifierLike[] | undefineddot-dot-dot-token: DotDotDotToken | undefinedname: string | BindingNamequestion-token: QuestionToken | undefinedtype: TypeNode | undefinedinitializer: Expression | undefinedReturns: ParameterDeclaration
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `dot-dot-dot-token`: `DotDotDotToken | undefined` - `name`: `string | BindingName` - `question-token`: `QuestionToken | undefined` - `type`: `TypeNode | undefined` - `initializer`: `Expression | undefined` **Returns:** `ParameterDeclaration`
(create-parenthesized-expression node-factory expression)Parameters:
expression: ExpressionReturns: ParenthesizedExpression
**Parameters:** - `expression`: `Expression` **Returns:** `ParenthesizedExpression`
(create-parenthesized-type node-factory type)Parameters:
type: TypeNodeReturns: ParenthesizedTypeNode
**Parameters:** - `type`: `TypeNode` **Returns:** `ParenthesizedTypeNode`
(create-partially-emitted-expression node-factory expression)(create-partially-emitted-expression node-factory expression original)Parameters:
expression: Expressionoriginal: Node | undefinedReturns: PartiallyEmittedExpression
**Parameters:** - `expression`: `Expression` - `original`: `Node | undefined` **Returns:** `PartiallyEmittedExpression`
(create-postfix-decrement node-factory operand)Parameters:
operand: ExpressionReturns: PostfixUnaryExpression
**Parameters:** - `operand`: `Expression` **Returns:** `PostfixUnaryExpression`
(create-postfix-increment node-factory operand)Parameters:
operand: ExpressionReturns: PostfixUnaryExpression
**Parameters:** - `operand`: `Expression` **Returns:** `PostfixUnaryExpression`
(create-postfix-unary-expression node-factory operand operator)Parameters:
operand: Expressionoperator: PostfixUnaryOperatorReturns: PostfixUnaryExpression
**Parameters:** - `operand`: `Expression` - `operator`: `PostfixUnaryOperator` **Returns:** `PostfixUnaryExpression`
(create-prefix-decrement node-factory operand)Parameters:
operand: ExpressionReturns: PrefixUnaryExpression
**Parameters:** - `operand`: `Expression` **Returns:** `PrefixUnaryExpression`
(create-prefix-increment node-factory operand)Parameters:
operand: ExpressionReturns: PrefixUnaryExpression
**Parameters:** - `operand`: `Expression` **Returns:** `PrefixUnaryExpression`
(create-prefix-minus node-factory operand)Parameters:
operand: ExpressionReturns: PrefixUnaryExpression
**Parameters:** - `operand`: `Expression` **Returns:** `PrefixUnaryExpression`
(create-prefix-plus node-factory operand)Parameters:
operand: ExpressionReturns: PrefixUnaryExpression
**Parameters:** - `operand`: `Expression` **Returns:** `PrefixUnaryExpression`
(create-prefix-unary-expression node-factory operator operand)Parameters:
operator: PrefixUnaryOperatoroperand: ExpressionReturns: PrefixUnaryExpression
**Parameters:** - `operator`: `PrefixUnaryOperator` - `operand`: `Expression` **Returns:** `PrefixUnaryExpression`
(create-private-identifier node-factory text)Parameters:
text: stringReturns: PrivateIdentifier
**Parameters:** - `text`: `string` **Returns:** `PrivateIdentifier`
(create-property-access-chain node-factory expression)(create-property-access-chain node-factory expression question-dot-token)(create-property-access-chain node-factory expression question-dot-token name)Parameters:
expression: Expressionquestion-dot-token: QuestionDotToken | undefinedname: string | MemberNameReturns: PropertyAccessChain
**Parameters:** - `expression`: `Expression` - `question-dot-token`: `QuestionDotToken | undefined` - `name`: `string | MemberName` **Returns:** `PropertyAccessChain`
(create-property-access-expression node-factory expression name)Parameters:
expression: Expressionname: string | MemberNameReturns: PropertyAccessExpression
**Parameters:** - `expression`: `Expression` - `name`: `string | MemberName` **Returns:** `PropertyAccessExpression`
(create-property-assignment node-factory name initializer)Parameters:
name: string | PropertyNameinitializer: ExpressionReturns: PropertyAssignment
**Parameters:** - `name`: `string | PropertyName` - `initializer`: `Expression` **Returns:** `PropertyAssignment`
(create-property-declaration node-factory)(create-property-declaration node-factory modifiers)(create-property-declaration node-factory modifiers name)(create-property-declaration node-factory
modifiers
name
question-or-exclamation-token)(create-property-declaration node-factory
modifiers
name
question-or-exclamation-token
type)(create-property-declaration node-factory
modifiers
name
question-or-exclamation-token
type
initializer)Parameters:
modifiers: readonly ModifierLike[] | undefinedname: string | PropertyNamequestion-or-exclamation-token: QuestionToken | ExclamationToken | undefinedtype: TypeNode | undefinedinitializer: Expression | undefinedReturns: PropertyDeclaration
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `name`: `string | PropertyName` - `question-or-exclamation-token`: `QuestionToken | ExclamationToken | undefined` - `type`: `TypeNode | undefined` - `initializer`: `Expression | undefined` **Returns:** `PropertyDeclaration`
(create-property-signature node-factory)(create-property-signature node-factory modifiers)(create-property-signature node-factory modifiers name)(create-property-signature node-factory modifiers name question-token)(create-property-signature node-factory modifiers name question-token type)Parameters:
modifiers: readonly Modifier[] | undefinedname: string | PropertyNamequestion-token: QuestionToken | undefinedtype: TypeNode | undefinedReturns: PropertySignature
**Parameters:** - `modifiers`: `readonly Modifier[] | undefined` - `name`: `string | PropertyName` - `question-token`: `QuestionToken | undefined` - `type`: `TypeNode | undefined` **Returns:** `PropertySignature`
(create-qualified-name node-factory left right)Parameters:
left: EntityNameright: string | IdentifierReturns: QualifiedName
**Parameters:** - `left`: `EntityName` - `right`: `string | Identifier` **Returns:** `QualifiedName`
(create-regular-expression-literal node-factory text)Parameters:
text: stringReturns: RegularExpressionLiteral
**Parameters:** - `text`: `string` **Returns:** `RegularExpressionLiteral`
(create-rest-type-node node-factory type)Parameters:
type: TypeNodeReturns: RestTypeNode
**Parameters:** - `type`: `TypeNode` **Returns:** `RestTypeNode`
(create-return-statement node-factory)(create-return-statement node-factory expression)Parameters:
expression: Expression | undefinedReturns: ReturnStatement
**Parameters:** - `expression`: `Expression | undefined` **Returns:** `ReturnStatement`
(create-right-shift node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-satisfies-expression node-factory expression type)Parameters:
expression: Expressiontype: TypeNodeReturns: SatisfiesExpression
**Parameters:** - `expression`: `Expression` - `type`: `TypeNode` **Returns:** `SatisfiesExpression`
(create-semicolon-class-element node-factory)Returns: SemicolonClassElement
**Returns:** `SemicolonClassElement`
(create-set-accessor-declaration node-factory)(create-set-accessor-declaration node-factory modifiers)(create-set-accessor-declaration node-factory modifiers name)(create-set-accessor-declaration node-factory modifiers name parameters)(create-set-accessor-declaration node-factory modifiers name parameters body)Parameters:
modifiers: readonly ModifierLike[] | undefinedname: string | PropertyNameparameters: readonly ParameterDeclaration[]body: Block | undefinedReturns: SetAccessorDeclaration
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `name`: `string | PropertyName` - `parameters`: `readonly ParameterDeclaration[]` - `body`: `Block | undefined` **Returns:** `SetAccessorDeclaration`
(create-shorthand-property-assignment node-factory name)(create-shorthand-property-assignment node-factory
name
object-assignment-initializer)Parameters:
name: string | Identifierobject-assignment-initializer: Expression | undefinedReturns: ShorthandPropertyAssignment
**Parameters:** - `name`: `string | Identifier` - `object-assignment-initializer`: `Expression | undefined` **Returns:** `ShorthandPropertyAssignment`
(create-source-file node-factory statements end-of-file-token flags)Parameters:
statements: readonly Statement[]end-of-file-token: EndOfFileTokenflags: NodeFlagsReturns: SourceFile
**Parameters:** - `statements`: `readonly Statement[]` - `end-of-file-token`: `EndOfFileToken` - `flags`: `NodeFlags` **Returns:** `SourceFile`
(create-spread-assignment node-factory expression)Parameters:
expression: ExpressionReturns: SpreadAssignment
**Parameters:** - `expression`: `Expression` **Returns:** `SpreadAssignment`
(create-spread-element node-factory expression)Parameters:
expression: ExpressionReturns: SpreadElement
**Parameters:** - `expression`: `Expression` **Returns:** `SpreadElement`
(create-strict-equality node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-strict-inequality node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-string-literal node-factory text)(create-string-literal node-factory text single-quote?)Parameters:
text: stringsingle-quote?: boolean | undefinedReturns: StringLiteral
**Parameters:** - `text`: `string` - `single-quote?`: `boolean | undefined` **Returns:** `StringLiteral`
(create-string-literal-from-node node-factory source-node)(create-string-literal-from-node node-factory source-node single-quote?)Parameters:
source-node: PrivateIdentifier | PropertyNameLiteralsingle-quote?: boolean | undefinedReturns: StringLiteral
**Parameters:** - `source-node`: `PrivateIdentifier | PropertyNameLiteral` - `single-quote?`: `boolean | undefined` **Returns:** `StringLiteral`
(create-subtract node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-super node-factory)Returns: SuperExpression
**Returns:** `SuperExpression`
(create-switch-statement node-factory expression case-block)Parameters:
expression: Expressioncase-block: CaseBlockReturns: SwitchStatement
**Parameters:** - `expression`: `Expression` - `case-block`: `CaseBlock` **Returns:** `SwitchStatement`
(create-tagged-template-expression node-factory tag)(create-tagged-template-expression node-factory tag type-arguments)(create-tagged-template-expression node-factory tag type-arguments template)Parameters:
tag: Expressiontype-arguments: readonly TypeNode[] | undefinedtemplate: TemplateLiteralReturns: TaggedTemplateExpression
**Parameters:** - `tag`: `Expression` - `type-arguments`: `readonly TypeNode[] | undefined` - `template`: `TemplateLiteral` **Returns:** `TaggedTemplateExpression`
(create-temp-variable node-factory)(create-temp-variable node-factory record-temp-variable)(create-temp-variable node-factory
record-temp-variable
reserved-in-nested-scopes?)Create a unique temporary variable.
Parameters:
record-temp-variable: ((node: Identifier) => void) | undefined - An optional callback used to record the temporary variable name. This
should usually be a reference to hoistVariableDeclaration from a TransformationContext, but
can be undefined if you plan to record the temporary variable manually.reserved-in-nested-scopes?: boolean | undefined - 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
Create a unique temporary variable. **Parameters:** - `record-temp-variable`: `((node: Identifier) => void) | undefined` - An optional callback used to record the temporary variable name. This should usually be a reference to `hoistVariableDeclaration` from a `TransformationContext`, but can be `undefined` if you plan to record the temporary variable manually. - `reserved-in-nested-scopes?`: `boolean | undefined` - 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`
(create-template-expression node-factory head template-spans)Parameters:
head: TemplateHeadtemplate-spans: readonly TemplateSpan[]Returns: TemplateExpression
**Parameters:** - `head`: `TemplateHead` - `template-spans`: `readonly TemplateSpan[]` **Returns:** `TemplateExpression`
(create-template-head node-factory)(create-template-head node-factory text)(create-template-head node-factory text raw-text)(create-template-head node-factory text raw-text template-flags)Parameters:
text: string | undefinedraw-text: stringtemplate-flags: TokenFlags | undefinedReturns: TemplateHead
**Parameters:** - `text`: `string | undefined` - `raw-text`: `string` - `template-flags`: `TokenFlags | undefined` **Returns:** `TemplateHead`
(create-template-literal-type node-factory head template-spans)Parameters:
head: TemplateHeadtemplate-spans: readonly TemplateLiteralTypeSpan[]Returns: TemplateLiteralTypeNode
**Parameters:** - `head`: `TemplateHead` - `template-spans`: `readonly TemplateLiteralTypeSpan[]` **Returns:** `TemplateLiteralTypeNode`
(create-template-literal-type-span node-factory type literal)Parameters:
type: TypeNodeliteral: TemplateMiddle | TemplateTailReturns: TemplateLiteralTypeSpan
**Parameters:** - `type`: `TypeNode` - `literal`: `TemplateMiddle | TemplateTail` **Returns:** `TemplateLiteralTypeSpan`
(create-template-middle node-factory)(create-template-middle node-factory text)(create-template-middle node-factory text raw-text)(create-template-middle node-factory text raw-text template-flags)Parameters:
text: string | undefinedraw-text: stringtemplate-flags: TokenFlags | undefinedReturns: TemplateMiddle
**Parameters:** - `text`: `string | undefined` - `raw-text`: `string` - `template-flags`: `TokenFlags | undefined` **Returns:** `TemplateMiddle`
(create-template-span node-factory expression literal)Parameters:
expression: Expressionliteral: TemplateMiddle | TemplateTailReturns: TemplateSpan
**Parameters:** - `expression`: `Expression` - `literal`: `TemplateMiddle | TemplateTail` **Returns:** `TemplateSpan`
(create-template-tail node-factory)(create-template-tail node-factory text)(create-template-tail node-factory text raw-text)(create-template-tail node-factory text raw-text template-flags)Parameters:
text: string | undefinedraw-text: stringtemplate-flags: TokenFlags | undefinedReturns: TemplateTail
**Parameters:** - `text`: `string | undefined` - `raw-text`: `string` - `template-flags`: `TokenFlags | undefined` **Returns:** `TemplateTail`
(create-this node-factory)Returns: ThisExpression
**Returns:** `ThisExpression`
(create-this-type-node node-factory)Returns: ThisTypeNode
**Returns:** `ThisTypeNode`
(create-throw-statement node-factory expression)Parameters:
expression: ExpressionReturns: ThrowStatement
**Parameters:** - `expression`: `Expression` **Returns:** `ThrowStatement`
(create-token node-factory token)Parameters:
token: TKindReturns: KeywordToken<TKind>
**Parameters:** - `token`: `TKind` **Returns:** `KeywordToken<TKind>`
(create-true node-factory)Returns: TrueLiteral
**Returns:** `TrueLiteral`
(create-try-statement node-factory try-block)(create-try-statement node-factory try-block catch-clause)(create-try-statement node-factory try-block catch-clause finally-block)Parameters:
try-block: Blockcatch-clause: CatchClause | undefinedfinally-block: Block | undefinedReturns: TryStatement
**Parameters:** - `try-block`: `Block` - `catch-clause`: `CatchClause | undefined` - `finally-block`: `Block | undefined` **Returns:** `TryStatement`
(create-tuple-type-node node-factory elements)Parameters:
elements: readonly (TypeNode | NamedTupleMember)[]Returns: TupleTypeNode
**Parameters:** - `elements`: `readonly (TypeNode | NamedTupleMember)[]` **Returns:** `TupleTypeNode`
(create-type-alias-declaration node-factory)(create-type-alias-declaration node-factory modifiers)(create-type-alias-declaration node-factory modifiers name)(create-type-alias-declaration node-factory modifiers name type-parameters)(create-type-alias-declaration node-factory modifiers name type-parameters type)Parameters:
modifiers: readonly ModifierLike[] | undefinedname: string | Identifiertype-parameters: readonly TypeParameterDeclaration[] | undefinedtype: TypeNodeReturns: TypeAliasDeclaration
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `name`: `string | Identifier` - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `type`: `TypeNode` **Returns:** `TypeAliasDeclaration`
(create-type-assertion node-factory type expression)Parameters:
type: TypeNodeexpression: ExpressionReturns: TypeAssertion
**Parameters:** - `type`: `TypeNode` - `expression`: `Expression` **Returns:** `TypeAssertion`
(create-type-literal-node node-factory)(create-type-literal-node node-factory members)Parameters:
members: readonly TypeElement[] | undefinedReturns: TypeLiteralNode
**Parameters:** - `members`: `readonly TypeElement[] | undefined` **Returns:** `TypeLiteralNode`
(create-type-of-expression node-factory expression)Parameters:
expression: ExpressionReturns: TypeOfExpression
**Parameters:** - `expression`: `Expression` **Returns:** `TypeOfExpression`
(create-type-operator-node node-factory operator type)Parameters:
operator: SyntaxKind.KeyOfKeyword | SyntaxKind.ReadonlyKeyword | SyntaxKind.UniqueKeywordtype: TypeNodeReturns: TypeOperatorNode
**Parameters:** - `operator`: `SyntaxKind.KeyOfKeyword | SyntaxKind.ReadonlyKeyword | SyntaxKind.UniqueKeyword` - `type`: `TypeNode` **Returns:** `TypeOperatorNode`
(create-type-parameter-declaration node-factory)(create-type-parameter-declaration node-factory modifiers)(create-type-parameter-declaration node-factory modifiers name)(create-type-parameter-declaration node-factory modifiers name constraint)(create-type-parameter-declaration node-factory
modifiers
name
constraint
default-type)Parameters:
modifiers: readonly Modifier[] | undefinedname: string | Identifierconstraint: TypeNode | undefineddefault-type: TypeNode | undefinedReturns: TypeParameterDeclaration
**Parameters:** - `modifiers`: `readonly Modifier[] | undefined` - `name`: `string | Identifier` - `constraint`: `TypeNode | undefined` - `default-type`: `TypeNode | undefined` **Returns:** `TypeParameterDeclaration`
(create-type-predicate-node node-factory)(create-type-predicate-node node-factory asserts-modifier)(create-type-predicate-node node-factory asserts-modifier parameter-name)(create-type-predicate-node node-factory asserts-modifier parameter-name type)Parameters:
asserts-modifier: AssertsKeyword | undefinedparameter-name: string | Identifier | ThisTypeNodetype: TypeNode | undefinedReturns: TypePredicateNode
**Parameters:** - `asserts-modifier`: `AssertsKeyword | undefined` - `parameter-name`: `string | Identifier | ThisTypeNode` - `type`: `TypeNode | undefined` **Returns:** `TypePredicateNode`
(create-type-query-node node-factory expr-name)(create-type-query-node node-factory expr-name type-arguments)Parameters:
expr-name: EntityNametype-arguments: readonly TypeNode[] | undefinedReturns: TypeQueryNode
**Parameters:** - `expr-name`: `EntityName` - `type-arguments`: `readonly TypeNode[] | undefined` **Returns:** `TypeQueryNode`
(create-type-reference-node node-factory type-name)(create-type-reference-node node-factory type-name type-arguments)Parameters:
type-name: string | EntityNametype-arguments: readonly TypeNode[] | undefinedReturns: TypeReferenceNode
**Parameters:** - `type-name`: `string | EntityName` - `type-arguments`: `readonly TypeNode[] | undefined` **Returns:** `TypeReferenceNode`
(create-union-type-node node-factory types)Parameters:
types: readonly TypeNode[]Returns: UnionTypeNode
**Parameters:** - `types`: `readonly TypeNode[]` **Returns:** `UnionTypeNode`
(create-unique-name node-factory text)(create-unique-name node-factory text flags)Create a unique name based on the supplied text.
Parameters:
text: stringflags: GeneratedIdentifierFlags | undefinedReturns: Identifier
Create a unique name based on the supplied text. **Parameters:** - `text`: `string` - `flags`: `GeneratedIdentifierFlags | undefined` **Returns:** `Identifier`
(create-unique-private-name node-factory)(create-unique-private-name node-factory text)Parameters:
text: string | undefinedReturns: PrivateIdentifier
**Parameters:** - `text`: `string | undefined` **Returns:** `PrivateIdentifier`
(create-unsigned-right-shift node-factory left right)Parameters:
left: Expressionright: ExpressionReturns: BinaryExpression
**Parameters:** - `left`: `Expression` - `right`: `Expression` **Returns:** `BinaryExpression`
(create-variable-declaration node-factory name)(create-variable-declaration node-factory name exclamation-token)(create-variable-declaration node-factory name exclamation-token type)(create-variable-declaration node-factory
name
exclamation-token
type
initializer)Parameters:
name: string | BindingNameexclamation-token: ExclamationToken | undefinedtype: TypeNode | undefinedinitializer: Expression | undefinedReturns: VariableDeclaration
**Parameters:** - `name`: `string | BindingName` - `exclamation-token`: `ExclamationToken | undefined` - `type`: `TypeNode | undefined` - `initializer`: `Expression | undefined` **Returns:** `VariableDeclaration`
(create-variable-declaration-list node-factory declarations)(create-variable-declaration-list node-factory declarations flags)Parameters:
declarations: readonly VariableDeclaration[]flags: NodeFlags | undefinedReturns: VariableDeclarationList
**Parameters:** - `declarations`: `readonly VariableDeclaration[]` - `flags`: `NodeFlags | undefined` **Returns:** `VariableDeclarationList`
(create-variable-statement node-factory)(create-variable-statement node-factory modifiers)(create-variable-statement node-factory modifiers declaration-list)Parameters:
modifiers: readonly ModifierLike[] | undefineddeclaration-list: VariableDeclarationList | readonly VariableDeclaration[]Returns: VariableStatement
**Parameters:** - `modifiers`: `readonly ModifierLike[] | undefined` - `declaration-list`: `VariableDeclarationList | readonly VariableDeclaration[]` **Returns:** `VariableStatement`
(create-void-expression node-factory expression)Parameters:
expression: ExpressionReturns: VoidExpression
**Parameters:** - `expression`: `Expression` **Returns:** `VoidExpression`
(create-void-zero node-factory)Returns: VoidExpression
**Returns:** `VoidExpression`
(create-while-statement node-factory expression statement)Parameters:
expression: Expressionstatement: StatementReturns: WhileStatement
**Parameters:** - `expression`: `Expression` - `statement`: `Statement` **Returns:** `WhileStatement`
(create-with-statement node-factory expression statement)Parameters:
expression: Expressionstatement: StatementReturns: WithStatement
**Parameters:** - `expression`: `Expression` - `statement`: `Statement` **Returns:** `WithStatement`
(create-yield-expression node-factory)(create-yield-expression node-factory asterisk-token)(create-yield-expression node-factory asterisk-token expression)Parameters:
asterisk-token: undefinedexpression: Expression | undefinedReturns: YieldExpression
**Parameters:** - `asterisk-token`: `undefined` - `expression`: `Expression | undefined` **Returns:** `YieldExpression`
(generated-name-for-node node-factory)(generated-name-for-node node-factory node)(generated-name-for-node node-factory node flags)Create a unique name generated for a node.
Parameters:
node: Node | undefinedflags: GeneratedIdentifierFlags | undefinedReturns: Identifier
Create a unique name generated for a node. **Parameters:** - `node`: `Node | undefined` - `flags`: `GeneratedIdentifierFlags | undefined` **Returns:** `Identifier`
(generated-private-name-for-node node-factory node)Parameters:
node: NodeReturns: PrivateIdentifier
**Parameters:** - `node`: `Node` **Returns:** `PrivateIdentifier`
(replace-decorators-and-modifiers node-factory node)(replace-decorators-and-modifiers node-factory node modifiers)Updates a node that may contain decorators or modifiers, replacing only the decorators and modifiers of the node.
Parameters:
node: Tmodifiers: readonly ModifierLike[] | undefinedReturns: T
Updates a node that may contain decorators or modifiers, replacing only the decorators and modifiers of the node. **Parameters:** - `node`: `T` - `modifiers`: `readonly ModifierLike[] | undefined` **Returns:** `T`
(replace-modifiers node-factory node)(replace-modifiers node-factory node modifiers)Updates a node that may contain modifiers, replacing only the modifiers of the node.
Parameters:
node: Tmodifiers: ModifierFlags | readonly Modifier[] | undefinedReturns: T
Updates a node that may contain modifiers, replacing only the modifiers of the node. **Parameters:** - `node`: `T` - `modifiers`: `ModifierFlags | readonly Modifier[] | undefined` **Returns:** `T`
(replace-property-name node-factory node name)Updates a node that contains a property name, replacing only the name of the node.
Parameters:
node: Tname: T["name"]Returns: T
Updates a node that contains a property name, replacing only the name of the node. **Parameters:** - `node`: `T` - `name`: `T["name"]` **Returns:** `T`
(restore-outer-expressions node-factory)(restore-outer-expressions node-factory outer-expression)(restore-outer-expressions node-factory outer-expression inner-expression)(restore-outer-expressions node-factory outer-expression inner-expression kinds)Parameters:
outer-expression: Expression | undefinedinner-expression: Expressionkinds: OuterExpressionKinds | undefinedReturns: Expression
**Parameters:** - `outer-expression`: `Expression | undefined` - `inner-expression`: `Expression` - `kinds`: `OuterExpressionKinds | undefined` **Returns:** `Expression`
(update-array-binding-pattern node-factory node elements)Parameters:
node: ArrayBindingPatternelements: readonly ArrayBindingElement[]Returns: ArrayBindingPattern
**Parameters:** - `node`: `ArrayBindingPattern` - `elements`: `readonly ArrayBindingElement[]` **Returns:** `ArrayBindingPattern`
(update-array-literal-expression node-factory node elements)Parameters:
node: ArrayLiteralExpressionelements: readonly Expression[]Returns: ArrayLiteralExpression
**Parameters:** - `node`: `ArrayLiteralExpression` - `elements`: `readonly Expression[]` **Returns:** `ArrayLiteralExpression`
(update-array-type-node node-factory node element-type)Parameters:
node: ArrayTypeNodeelement-type: TypeNodeReturns: ArrayTypeNode
**Parameters:** - `node`: `ArrayTypeNode` - `element-type`: `TypeNode` **Returns:** `ArrayTypeNode`
(update-arrow-function node-factory node)(update-arrow-function node-factory node modifiers)(update-arrow-function node-factory node modifiers type-parameters)(update-arrow-function node-factory node modifiers type-parameters parameters)(update-arrow-function node-factory
node
modifiers
type-parameters
parameters
type)(update-arrow-function node-factory
node
modifiers
type-parameters
parameters
type
equals-greater-than-token)(update-arrow-function node-factory
node
modifiers
type-parameters
parameters
type
equals-greater-than-token
body)Parameters:
node: ArrowFunctionmodifiers: readonly Modifier[] | undefinedtype-parameters: readonly TypeParameterDeclaration[] | undefinedparameters: readonly ParameterDeclaration[]type: TypeNode | undefinedequals-greater-than-token: EqualsGreaterThanTokenbody: ConciseBodyReturns: ArrowFunction
**Parameters:** - `node`: `ArrowFunction` - `modifiers`: `readonly Modifier[] | undefined` - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `parameters`: `readonly ParameterDeclaration[]` - `type`: `TypeNode | undefined` - `equals-greater-than-token`: `EqualsGreaterThanToken` - `body`: `ConciseBody` **Returns:** `ArrowFunction`
(update-as-expression node-factory node expression type)Parameters:
node: AsExpressionexpression: Expressiontype: TypeNodeReturns: AsExpression
**Parameters:** - `node`: `AsExpression` - `expression`: `Expression` - `type`: `TypeNode` **Returns:** `AsExpression`
(update-assert-clause node-factory node elements)(update-assert-clause node-factory node elements multi-line?)Parameters:
node: AssertClauseelements: NodeArray<AssertEntry>multi-line?: boolean | undefinedReturns: AssertClause
**Parameters:** - `node`: `AssertClause` - `elements`: `NodeArray<AssertEntry>` - `multi-line?`: `boolean | undefined` **Returns:** `AssertClause`
(update-assert-entry node-factory node name value)Parameters:
node: AssertEntryname: ImportAttributeNamevalue: ExpressionReturns: AssertEntry
**Parameters:** - `node`: `AssertEntry` - `name`: `ImportAttributeName` - `value`: `Expression` **Returns:** `AssertEntry`
(update-await-expression node-factory node expression)Parameters:
node: AwaitExpressionexpression: ExpressionReturns: AwaitExpression
**Parameters:** - `node`: `AwaitExpression` - `expression`: `Expression` **Returns:** `AwaitExpression`
(update-binary-expression node-factory node left operator right)Parameters:
node: BinaryExpressionleft: Expressionoperator: BinaryOperator | BinaryOperatorTokenright: ExpressionReturns: BinaryExpression
**Parameters:** - `node`: `BinaryExpression` - `left`: `Expression` - `operator`: `BinaryOperator | BinaryOperatorToken` - `right`: `Expression` **Returns:** `BinaryExpression`
(update-binding-element node-factory node)(update-binding-element node-factory node dot-dot-dot-token)(update-binding-element node-factory node dot-dot-dot-token property-name)(update-binding-element node-factory node dot-dot-dot-token property-name name)(update-binding-element node-factory
node
dot-dot-dot-token
property-name
name
initializer)Parameters:
node: BindingElementdot-dot-dot-token: DotDotDotToken | undefinedproperty-name: PropertyName | undefinedname: BindingNameinitializer: Expression | undefinedReturns: BindingElement
**Parameters:** - `node`: `BindingElement` - `dot-dot-dot-token`: `DotDotDotToken | undefined` - `property-name`: `PropertyName | undefined` - `name`: `BindingName` - `initializer`: `Expression | undefined` **Returns:** `BindingElement`
(update-block node-factory node statements)Parameters:
node: Blockstatements: readonly Statement[]Returns: Block
**Parameters:** - `node`: `Block` - `statements`: `readonly Statement[]` **Returns:** `Block`
(update-break-statement node-factory node)(update-break-statement node-factory node label)Parameters:
node: BreakStatementlabel: Identifier | undefinedReturns: BreakStatement
**Parameters:** - `node`: `BreakStatement` - `label`: `Identifier | undefined` **Returns:** `BreakStatement`
(update-bundle node-factory node source-files)(update-bundle node-factory node source-files prepends)Parameters:
node: Bundlesource-files: readonly SourceFile[]prepends: readonly (UnparsedSource | InputFiles)[] | undefinedReturns: Bundle
**Parameters:** - `node`: `Bundle` - `source-files`: `readonly SourceFile[]` - `prepends`: `readonly (UnparsedSource | InputFiles)[] | undefined` **Returns:** `Bundle`
(update-call-chain node-factory node expression)(update-call-chain node-factory node expression question-dot-token)(update-call-chain node-factory
node
expression
question-dot-token
type-arguments)(update-call-chain node-factory
node
expression
question-dot-token
type-arguments
arguments-array)Parameters:
node: CallChainexpression: Expressionquestion-dot-token: QuestionDotToken | undefinedtype-arguments: readonly TypeNode[] | undefinedarguments-array: readonly Expression[]Returns: CallChain
**Parameters:** - `node`: `CallChain` - `expression`: `Expression` - `question-dot-token`: `QuestionDotToken | undefined` - `type-arguments`: `readonly TypeNode[] | undefined` - `arguments-array`: `readonly Expression[]` **Returns:** `CallChain`
(update-call-expression node-factory node expression)(update-call-expression node-factory node expression type-arguments)(update-call-expression node-factory
node
expression
type-arguments
arguments-array)Parameters:
node: CallExpressionexpression: Expressiontype-arguments: readonly TypeNode[] | undefinedarguments-array: readonly Expression[]Returns: CallExpression
**Parameters:** - `node`: `CallExpression` - `expression`: `Expression` - `type-arguments`: `readonly TypeNode[] | undefined` - `arguments-array`: `readonly Expression[]` **Returns:** `CallExpression`
(update-call-signature node-factory node)(update-call-signature node-factory node type-parameters)(update-call-signature node-factory node type-parameters parameters)(update-call-signature node-factory node type-parameters parameters type)Parameters:
node: CallSignatureDeclarationtype-parameters: NodeArray<TypeParameterDeclaration> | undefinedparameters: NodeArray<ParameterDeclaration>type: TypeNode | undefinedReturns: CallSignatureDeclaration
**Parameters:** - `node`: `CallSignatureDeclaration` - `type-parameters`: `NodeArray<TypeParameterDeclaration> | undefined` - `parameters`: `NodeArray<ParameterDeclaration>` - `type`: `TypeNode | undefined` **Returns:** `CallSignatureDeclaration`
(update-case-block node-factory node clauses)Parameters:
node: CaseBlockclauses: readonly CaseOrDefaultClause[]Returns: CaseBlock
**Parameters:** - `node`: `CaseBlock` - `clauses`: `readonly CaseOrDefaultClause[]` **Returns:** `CaseBlock`
(update-case-clause node-factory node expression statements)Parameters:
node: CaseClauseexpression: Expressionstatements: readonly Statement[]Returns: CaseClause
**Parameters:** - `node`: `CaseClause` - `expression`: `Expression` - `statements`: `readonly Statement[]` **Returns:** `CaseClause`
(update-catch-clause node-factory node)(update-catch-clause node-factory node variable-declaration)(update-catch-clause node-factory node variable-declaration block)Parameters:
node: CatchClausevariable-declaration: VariableDeclaration | undefinedblock: BlockReturns: CatchClause
**Parameters:** - `node`: `CatchClause` - `variable-declaration`: `VariableDeclaration | undefined` - `block`: `Block` **Returns:** `CatchClause`
(update-class-declaration node-factory node)(update-class-declaration node-factory node modifiers)(update-class-declaration node-factory node modifiers name)(update-class-declaration node-factory node modifiers name type-parameters)(update-class-declaration node-factory
node
modifiers
name
type-parameters
heritage-clauses)(update-class-declaration node-factory
node
modifiers
name
type-parameters
heritage-clauses
members)Parameters:
node: ClassDeclarationmodifiers: readonly ModifierLike[] | undefinedname: Identifier | undefinedtype-parameters: readonly TypeParameterDeclaration[] | undefinedheritage-clauses: readonly HeritageClause[] | undefinedmembers: readonly ClassElement[]Returns: ClassDeclaration
**Parameters:** - `node`: `ClassDeclaration` - `modifiers`: `readonly ModifierLike[] | undefined` - `name`: `Identifier | undefined` - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `heritage-clauses`: `readonly HeritageClause[] | undefined` - `members`: `readonly ClassElement[]` **Returns:** `ClassDeclaration`
(update-class-expression node-factory node)(update-class-expression node-factory node modifiers)(update-class-expression node-factory node modifiers name)(update-class-expression node-factory node modifiers name type-parameters)(update-class-expression node-factory
node
modifiers
name
type-parameters
heritage-clauses)(update-class-expression node-factory
node
modifiers
name
type-parameters
heritage-clauses
members)Parameters:
node: ClassExpressionmodifiers: readonly ModifierLike[] | undefinedname: Identifier | undefinedtype-parameters: readonly TypeParameterDeclaration[] | undefinedheritage-clauses: readonly HeritageClause[] | undefinedmembers: readonly ClassElement[]Returns: ClassExpression
**Parameters:** - `node`: `ClassExpression` - `modifiers`: `readonly ModifierLike[] | undefined` - `name`: `Identifier | undefined` - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `heritage-clauses`: `readonly HeritageClause[] | undefined` - `members`: `readonly ClassElement[]` **Returns:** `ClassExpression`
(update-class-static-block-declaration node-factory node body)Parameters:
node: ClassStaticBlockDeclarationbody: BlockReturns: ClassStaticBlockDeclaration
**Parameters:** - `node`: `ClassStaticBlockDeclaration` - `body`: `Block` **Returns:** `ClassStaticBlockDeclaration`
(update-comma-list-expression node-factory node elements)Parameters:
node: CommaListExpressionelements: readonly Expression[]Returns: CommaListExpression
**Parameters:** - `node`: `CommaListExpression` - `elements`: `readonly Expression[]` **Returns:** `CommaListExpression`
(update-computed-property-name node-factory node expression)Parameters:
node: ComputedPropertyNameexpression: ExpressionReturns: ComputedPropertyName
**Parameters:** - `node`: `ComputedPropertyName` - `expression`: `Expression` **Returns:** `ComputedPropertyName`
(update-conditional-expression node-factory
node
condition
question-token
when-true
colon-token
when-false)Parameters:
node: ConditionalExpressioncondition: Expressionquestion-token: QuestionTokenwhen-true: Expressioncolon-token: ColonTokenwhen-false: ExpressionReturns: ConditionalExpression
**Parameters:** - `node`: `ConditionalExpression` - `condition`: `Expression` - `question-token`: `QuestionToken` - `when-true`: `Expression` - `colon-token`: `ColonToken` - `when-false`: `Expression` **Returns:** `ConditionalExpression`
(update-conditional-type-node node-factory
node
check-type
extends-type
true-type
false-type)Parameters:
node: ConditionalTypeNodecheck-type: TypeNodeextends-type: TypeNodetrue-type: TypeNodefalse-type: TypeNodeReturns: ConditionalTypeNode
**Parameters:** - `node`: `ConditionalTypeNode` - `check-type`: `TypeNode` - `extends-type`: `TypeNode` - `true-type`: `TypeNode` - `false-type`: `TypeNode` **Returns:** `ConditionalTypeNode`
(update-construct-signature node-factory node)(update-construct-signature node-factory node type-parameters)(update-construct-signature node-factory node type-parameters parameters)(update-construct-signature node-factory node type-parameters parameters type)Parameters:
node: ConstructSignatureDeclarationtype-parameters: NodeArray<TypeParameterDeclaration> | undefinedparameters: NodeArray<ParameterDeclaration>type: TypeNode | undefinedReturns: ConstructSignatureDeclaration
**Parameters:** - `node`: `ConstructSignatureDeclaration` - `type-parameters`: `NodeArray<TypeParameterDeclaration> | undefined` - `parameters`: `NodeArray<ParameterDeclaration>` - `type`: `TypeNode | undefined` **Returns:** `ConstructSignatureDeclaration`
(update-constructor-declaration node-factory node)(update-constructor-declaration node-factory node modifiers)(update-constructor-declaration node-factory node modifiers parameters)(update-constructor-declaration node-factory node modifiers parameters body)Parameters:
node: ConstructorDeclarationmodifiers: readonly ModifierLike[] | undefinedparameters: readonly ParameterDeclaration[]body: Block | undefinedReturns: ConstructorDeclaration
**Parameters:** - `node`: `ConstructorDeclaration` - `modifiers`: `readonly ModifierLike[] | undefined` - `parameters`: `readonly ParameterDeclaration[]` - `body`: `Block | undefined` **Returns:** `ConstructorDeclaration`
(update-constructor-type-node node-factory node)(update-constructor-type-node node-factory node modifiers)(update-constructor-type-node node-factory node modifiers type-parameters)(update-constructor-type-node node-factory
node
modifiers
type-parameters
parameters)(update-constructor-type-node node-factory
node
modifiers
type-parameters
parameters
type)Parameters:
node: ConstructorTypeNodemodifiers: readonly Modifier[] | undefinedtype-parameters: NodeArray<TypeParameterDeclaration> | undefinedparameters: NodeArray<ParameterDeclaration>type: TypeNodeReturns: ConstructorTypeNode
**Parameters:** - `node`: `ConstructorTypeNode` - `modifiers`: `readonly Modifier[] | undefined` - `type-parameters`: `NodeArray<TypeParameterDeclaration> | undefined` - `parameters`: `NodeArray<ParameterDeclaration>` - `type`: `TypeNode` **Returns:** `ConstructorTypeNode`
(update-continue-statement node-factory node)(update-continue-statement node-factory node label)Parameters:
node: ContinueStatementlabel: Identifier | undefinedReturns: ContinueStatement
**Parameters:** - `node`: `ContinueStatement` - `label`: `Identifier | undefined` **Returns:** `ContinueStatement`
(update-decorator node-factory node expression)Parameters:
node: Decoratorexpression: ExpressionReturns: Decorator
**Parameters:** - `node`: `Decorator` - `expression`: `Expression` **Returns:** `Decorator`
(update-default-clause node-factory node statements)Parameters:
node: DefaultClausestatements: readonly Statement[]Returns: DefaultClause
**Parameters:** - `node`: `DefaultClause` - `statements`: `readonly Statement[]` **Returns:** `DefaultClause`
(update-delete-expression node-factory node expression)Parameters:
node: DeleteExpressionexpression: ExpressionReturns: DeleteExpression
**Parameters:** - `node`: `DeleteExpression` - `expression`: `Expression` **Returns:** `DeleteExpression`
(update-do-statement node-factory node statement expression)Parameters:
node: DoStatementstatement: Statementexpression: ExpressionReturns: DoStatement
**Parameters:** - `node`: `DoStatement` - `statement`: `Statement` - `expression`: `Expression` **Returns:** `DoStatement`
(update-element-access-chain node-factory node expression)(update-element-access-chain node-factory node expression question-dot-token)(update-element-access-chain node-factory
node
expression
question-dot-token
argument-expression)Parameters:
node: ElementAccessChainexpression: Expressionquestion-dot-token: QuestionDotToken | undefinedargument-expression: ExpressionReturns: ElementAccessChain
**Parameters:** - `node`: `ElementAccessChain` - `expression`: `Expression` - `question-dot-token`: `QuestionDotToken | undefined` - `argument-expression`: `Expression` **Returns:** `ElementAccessChain`
(update-element-access-expression node-factory
node
expression
argument-expression)Parameters:
node: ElementAccessExpressionexpression: Expressionargument-expression: ExpressionReturns: ElementAccessExpression
**Parameters:** - `node`: `ElementAccessExpression` - `expression`: `Expression` - `argument-expression`: `Expression` **Returns:** `ElementAccessExpression`
(update-enum-declaration node-factory node)(update-enum-declaration node-factory node modifiers)(update-enum-declaration node-factory node modifiers name)(update-enum-declaration node-factory node modifiers name members)Parameters:
node: EnumDeclarationmodifiers: readonly ModifierLike[] | undefinedname: Identifiermembers: readonly EnumMember[]Returns: EnumDeclaration
**Parameters:** - `node`: `EnumDeclaration` - `modifiers`: `readonly ModifierLike[] | undefined` - `name`: `Identifier` - `members`: `readonly EnumMember[]` **Returns:** `EnumDeclaration`
(update-enum-member node-factory node name)(update-enum-member node-factory node name initializer)Parameters:
node: EnumMembername: PropertyNameinitializer: Expression | undefinedReturns: EnumMember
**Parameters:** - `node`: `EnumMember` - `name`: `PropertyName` - `initializer`: `Expression | undefined` **Returns:** `EnumMember`
(update-export-assignment node-factory node)(update-export-assignment node-factory node modifiers)(update-export-assignment node-factory node modifiers expression)Parameters:
node: ExportAssignmentmodifiers: readonly ModifierLike[] | undefinedexpression: ExpressionReturns: ExportAssignment
**Parameters:** - `node`: `ExportAssignment` - `modifiers`: `readonly ModifierLike[] | undefined` - `expression`: `Expression` **Returns:** `ExportAssignment`
(update-export-declaration node-factory node)(update-export-declaration node-factory node modifiers)(update-export-declaration node-factory node modifiers type-only?)(update-export-declaration node-factory node modifiers type-only? export-clause)(update-export-declaration node-factory
node
modifiers
type-only?
export-clause
module-specifier)(update-export-declaration node-factory
node
modifiers
type-only?
export-clause
module-specifier
attributes)Parameters:
node: ExportDeclarationmodifiers: readonly ModifierLike[] | undefinedtype-only?: booleanexport-clause: NamedExportBindings | undefinedmodule-specifier: Expression | undefinedattributes: ImportAttributes | undefinedReturns: ExportDeclaration
**Parameters:** - `node`: `ExportDeclaration` - `modifiers`: `readonly ModifierLike[] | undefined` - `type-only?`: `boolean` - `export-clause`: `NamedExportBindings | undefined` - `module-specifier`: `Expression | undefined` - `attributes`: `ImportAttributes | undefined` **Returns:** `ExportDeclaration`
(update-export-specifier node-factory node type-only?)(update-export-specifier node-factory node type-only? property-name)(update-export-specifier node-factory node type-only? property-name name)Parameters:
node: ExportSpecifiertype-only?: booleanproperty-name: Identifier | undefinedname: IdentifierReturns: ExportSpecifier
**Parameters:** - `node`: `ExportSpecifier` - `type-only?`: `boolean` - `property-name`: `Identifier | undefined` - `name`: `Identifier` **Returns:** `ExportSpecifier`
(update-expression-statement node-factory node expression)Parameters:
node: ExpressionStatementexpression: ExpressionReturns: ExpressionStatement
**Parameters:** - `node`: `ExpressionStatement` - `expression`: `Expression` **Returns:** `ExpressionStatement`
(update-expression-with-type-arguments node-factory node expression)(update-expression-with-type-arguments node-factory
node
expression
type-arguments)Parameters:
node: ExpressionWithTypeArgumentsexpression: Expressiontype-arguments: readonly TypeNode[] | undefinedReturns: ExpressionWithTypeArguments
**Parameters:** - `node`: `ExpressionWithTypeArguments` - `expression`: `Expression` - `type-arguments`: `readonly TypeNode[] | undefined` **Returns:** `ExpressionWithTypeArguments`
(update-external-module-reference node-factory node expression)Parameters:
node: ExternalModuleReferenceexpression: ExpressionReturns: ExternalModuleReference
**Parameters:** - `node`: `ExternalModuleReference` - `expression`: `Expression` **Returns:** `ExternalModuleReference`
(update-for-in-statement node-factory node initializer expression statement)Parameters:
node: ForInStatementinitializer: ForInitializerexpression: Expressionstatement: StatementReturns: ForInStatement
**Parameters:** - `node`: `ForInStatement` - `initializer`: `ForInitializer` - `expression`: `Expression` - `statement`: `Statement` **Returns:** `ForInStatement`
(update-for-of-statement node-factory node)(update-for-of-statement node-factory node await-modifier)(update-for-of-statement node-factory node await-modifier initializer)(update-for-of-statement node-factory
node
await-modifier
initializer
expression)(update-for-of-statement node-factory
node
await-modifier
initializer
expression
statement)Parameters:
node: ForOfStatementawait-modifier: AwaitKeyword | undefinedinitializer: ForInitializerexpression: Expressionstatement: StatementReturns: ForOfStatement
**Parameters:** - `node`: `ForOfStatement` - `await-modifier`: `AwaitKeyword | undefined` - `initializer`: `ForInitializer` - `expression`: `Expression` - `statement`: `Statement` **Returns:** `ForOfStatement`
(update-for-statement node-factory node)(update-for-statement node-factory node initializer)(update-for-statement node-factory node initializer condition)(update-for-statement node-factory node initializer condition incrementor)(update-for-statement node-factory
node
initializer
condition
incrementor
statement)Parameters:
node: ForStatementinitializer: ForInitializer | undefinedcondition: Expression | undefinedincrementor: Expression | undefinedstatement: StatementReturns: ForStatement
**Parameters:** - `node`: `ForStatement` - `initializer`: `ForInitializer | undefined` - `condition`: `Expression | undefined` - `incrementor`: `Expression | undefined` - `statement`: `Statement` **Returns:** `ForStatement`
(update-function-declaration node-factory node)(update-function-declaration node-factory node modifiers)(update-function-declaration node-factory node modifiers asterisk-token)(update-function-declaration node-factory node modifiers asterisk-token name)(update-function-declaration node-factory
node
modifiers
asterisk-token
name
type-parameters)(update-function-declaration node-factory
node
modifiers
asterisk-token
name
type-parameters
parameters)(update-function-declaration node-factory
node
modifiers
asterisk-token
name
type-parameters
parameters
type)(update-function-declaration node-factory
node
modifiers
asterisk-token
name
type-parameters
parameters
type
body)Parameters:
node: FunctionDeclarationmodifiers: readonly ModifierLike[] | undefinedasterisk-token: AsteriskToken | undefinedname: Identifier | undefinedtype-parameters: readonly TypeParameterDeclaration[] | undefinedparameters: readonly ParameterDeclaration[]type: TypeNode | undefinedbody: Block | undefinedReturns: FunctionDeclaration
**Parameters:** - `node`: `FunctionDeclaration` - `modifiers`: `readonly ModifierLike[] | undefined` - `asterisk-token`: `AsteriskToken | undefined` - `name`: `Identifier | undefined` - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `parameters`: `readonly ParameterDeclaration[]` - `type`: `TypeNode | undefined` - `body`: `Block | undefined` **Returns:** `FunctionDeclaration`
(update-function-expression node-factory node)(update-function-expression node-factory node modifiers)(update-function-expression node-factory node modifiers asterisk-token)(update-function-expression node-factory node modifiers asterisk-token name)(update-function-expression node-factory
node
modifiers
asterisk-token
name
type-parameters)(update-function-expression node-factory
node
modifiers
asterisk-token
name
type-parameters
parameters)(update-function-expression node-factory
node
modifiers
asterisk-token
name
type-parameters
parameters
type)(update-function-expression node-factory
node
modifiers
asterisk-token
name
type-parameters
parameters
type
body)Parameters:
node: FunctionExpressionmodifiers: readonly Modifier[] | undefinedasterisk-token: AsteriskToken | undefinedname: Identifier | undefinedtype-parameters: readonly TypeParameterDeclaration[] | undefinedparameters: readonly ParameterDeclaration[]type: TypeNode | undefinedbody: BlockReturns: FunctionExpression
**Parameters:** - `node`: `FunctionExpression` - `modifiers`: `readonly Modifier[] | undefined` - `asterisk-token`: `AsteriskToken | undefined` - `name`: `Identifier | undefined` - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `parameters`: `readonly ParameterDeclaration[]` - `type`: `TypeNode | undefined` - `body`: `Block` **Returns:** `FunctionExpression`
(update-function-type-node node-factory node)(update-function-type-node node-factory node type-parameters)(update-function-type-node node-factory node type-parameters parameters)(update-function-type-node node-factory node type-parameters parameters type)Parameters:
node: FunctionTypeNodetype-parameters: NodeArray<TypeParameterDeclaration> | undefinedparameters: NodeArray<ParameterDeclaration>type: TypeNodeReturns: FunctionTypeNode
**Parameters:** - `node`: `FunctionTypeNode` - `type-parameters`: `NodeArray<TypeParameterDeclaration> | undefined` - `parameters`: `NodeArray<ParameterDeclaration>` - `type`: `TypeNode` **Returns:** `FunctionTypeNode`
(update-get-accessor-declaration node-factory node)(update-get-accessor-declaration node-factory node modifiers)(update-get-accessor-declaration node-factory node modifiers name)(update-get-accessor-declaration node-factory node modifiers name parameters)(update-get-accessor-declaration node-factory
node
modifiers
name
parameters
type)(update-get-accessor-declaration node-factory
node
modifiers
name
parameters
type
body)Parameters:
node: GetAccessorDeclarationmodifiers: readonly ModifierLike[] | undefinedname: PropertyNameparameters: readonly ParameterDeclaration[]type: TypeNode | undefinedbody: Block | undefinedReturns: GetAccessorDeclaration
**Parameters:** - `node`: `GetAccessorDeclaration` - `modifiers`: `readonly ModifierLike[] | undefined` - `name`: `PropertyName` - `parameters`: `readonly ParameterDeclaration[]` - `type`: `TypeNode | undefined` - `body`: `Block | undefined` **Returns:** `GetAccessorDeclaration`
(update-heritage-clause node-factory node types)Parameters:
node: HeritageClausetypes: readonly ExpressionWithTypeArguments[]Returns: HeritageClause
**Parameters:** - `node`: `HeritageClause` - `types`: `readonly ExpressionWithTypeArguments[]` **Returns:** `HeritageClause`
(update-if-statement node-factory node expression then-statement)(update-if-statement node-factory node expression then-statement else-statement)Parameters:
node: IfStatementexpression: Expressionthen-statement: Statementelse-statement: Statement | undefinedReturns: IfStatement
**Parameters:** - `node`: `IfStatement` - `expression`: `Expression` - `then-statement`: `Statement` - `else-statement`: `Statement | undefined` **Returns:** `IfStatement`
(update-import-attribute node-factory node name value)Parameters:
node: ImportAttributename: ImportAttributeNamevalue: ExpressionReturns: ImportAttribute
**Parameters:** - `node`: `ImportAttribute` - `name`: `ImportAttributeName` - `value`: `Expression` **Returns:** `ImportAttribute`
(update-import-attributes node-factory node elements)(update-import-attributes node-factory node elements multi-line?)Parameters:
node: ImportAttributeselements: NodeArray<ImportAttribute>multi-line?: boolean | undefinedReturns: ImportAttributes
**Parameters:** - `node`: `ImportAttributes` - `elements`: `NodeArray<ImportAttribute>` - `multi-line?`: `boolean | undefined` **Returns:** `ImportAttributes`
(update-import-clause node-factory node type-only?)(update-import-clause node-factory node type-only? name)(update-import-clause node-factory node type-only? name named-bindings)Parameters:
node: ImportClausetype-only?: booleanname: Identifier | undefinednamed-bindings: NamedImportBindings | undefinedReturns: ImportClause
**Parameters:** - `node`: `ImportClause` - `type-only?`: `boolean` - `name`: `Identifier | undefined` - `named-bindings`: `NamedImportBindings | undefined` **Returns:** `ImportClause`
(update-import-declaration node-factory node)(update-import-declaration node-factory node modifiers)(update-import-declaration node-factory node modifiers import-clause)(update-import-declaration node-factory
node
modifiers
import-clause
module-specifier)(update-import-declaration node-factory
node
modifiers
import-clause
module-specifier
attributes)Parameters:
node: ImportDeclarationmodifiers: readonly ModifierLike[] | undefinedimport-clause: ImportClause | undefinedmodule-specifier: Expressionattributes: ImportAttributes | undefinedReturns: ImportDeclaration
**Parameters:** - `node`: `ImportDeclaration` - `modifiers`: `readonly ModifierLike[] | undefined` - `import-clause`: `ImportClause | undefined` - `module-specifier`: `Expression` - `attributes`: `ImportAttributes | undefined` **Returns:** `ImportDeclaration`
(update-import-equals-declaration node-factory node)(update-import-equals-declaration node-factory node modifiers)(update-import-equals-declaration node-factory node modifiers type-only?)(update-import-equals-declaration node-factory node modifiers type-only? name)(update-import-equals-declaration node-factory
node
modifiers
type-only?
name
module-reference)Parameters:
node: ImportEqualsDeclarationmodifiers: readonly ModifierLike[] | undefinedtype-only?: booleanname: Identifiermodule-reference: ModuleReferenceReturns: ImportEqualsDeclaration
**Parameters:** - `node`: `ImportEqualsDeclaration` - `modifiers`: `readonly ModifierLike[] | undefined` - `type-only?`: `boolean` - `name`: `Identifier` - `module-reference`: `ModuleReference` **Returns:** `ImportEqualsDeclaration`
(update-import-specifier node-factory node type-only?)(update-import-specifier node-factory node type-only? property-name)(update-import-specifier node-factory node type-only? property-name name)Parameters:
node: ImportSpecifiertype-only?: booleanproperty-name: Identifier | undefinedname: IdentifierReturns: ImportSpecifier
**Parameters:** - `node`: `ImportSpecifier` - `type-only?`: `boolean` - `property-name`: `Identifier | undefined` - `name`: `Identifier` **Returns:** `ImportSpecifier`
(update-import-type-assertion-container node-factory node clause)(update-import-type-assertion-container node-factory node clause multi-line?)Parameters:
node: ImportTypeAssertionContainerclause: AssertClausemulti-line?: boolean | undefinedReturns: ImportTypeAssertionContainer
**Parameters:** - `node`: `ImportTypeAssertionContainer` - `clause`: `AssertClause` - `multi-line?`: `boolean | undefined` **Returns:** `ImportTypeAssertionContainer`
(update-import-type-node node-factory node argument)(update-import-type-node node-factory node argument attributes)(update-import-type-node node-factory node argument attributes qualifier)(update-import-type-node node-factory
node
argument
attributes
qualifier
type-arguments)(update-import-type-node node-factory
node
argument
attributes
qualifier
type-arguments
type-of?)Parameters:
node: ImportTypeNodeargument: TypeNodeattributes: ImportAttributes | undefinedqualifier: EntityName | undefinedtype-arguments: readonly TypeNode[] | undefinedtype-of?: boolean | undefinedReturns: ImportTypeNode
**Parameters:** - `node`: `ImportTypeNode` - `argument`: `TypeNode` - `attributes`: `ImportAttributes | undefined` - `qualifier`: `EntityName | undefined` - `type-arguments`: `readonly TypeNode[] | undefined` - `type-of?`: `boolean | undefined` **Returns:** `ImportTypeNode`
(update-index-signature node-factory node)(update-index-signature node-factory node modifiers)(update-index-signature node-factory node modifiers parameters)(update-index-signature node-factory node modifiers parameters type)Parameters:
node: IndexSignatureDeclarationmodifiers: readonly ModifierLike[] | undefinedparameters: readonly ParameterDeclaration[]type: TypeNodeReturns: IndexSignatureDeclaration
**Parameters:** - `node`: `IndexSignatureDeclaration` - `modifiers`: `readonly ModifierLike[] | undefined` - `parameters`: `readonly ParameterDeclaration[]` - `type`: `TypeNode` **Returns:** `IndexSignatureDeclaration`
(update-indexed-access-type-node node-factory node object-type index-type)Parameters:
node: IndexedAccessTypeNodeobject-type: TypeNodeindex-type: TypeNodeReturns: IndexedAccessTypeNode
**Parameters:** - `node`: `IndexedAccessTypeNode` - `object-type`: `TypeNode` - `index-type`: `TypeNode` **Returns:** `IndexedAccessTypeNode`
(update-infer-type-node node-factory node type-parameter)Parameters:
node: InferTypeNodetype-parameter: TypeParameterDeclarationReturns: InferTypeNode
**Parameters:** - `node`: `InferTypeNode` - `type-parameter`: `TypeParameterDeclaration` **Returns:** `InferTypeNode`
(update-interface-declaration node-factory node)(update-interface-declaration node-factory node modifiers)(update-interface-declaration node-factory node modifiers name)(update-interface-declaration node-factory node modifiers name type-parameters)(update-interface-declaration node-factory
node
modifiers
name
type-parameters
heritage-clauses)(update-interface-declaration node-factory
node
modifiers
name
type-parameters
heritage-clauses
members)Parameters:
node: InterfaceDeclarationmodifiers: readonly ModifierLike[] | undefinedname: Identifiertype-parameters: readonly TypeParameterDeclaration[] | undefinedheritage-clauses: readonly HeritageClause[] | undefinedmembers: readonly TypeElement[]Returns: InterfaceDeclaration
**Parameters:** - `node`: `InterfaceDeclaration` - `modifiers`: `readonly ModifierLike[] | undefined` - `name`: `Identifier` - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `heritage-clauses`: `readonly HeritageClause[] | undefined` - `members`: `readonly TypeElement[]` **Returns:** `InterfaceDeclaration`
(update-intersection-type-node node-factory node types)Parameters:
node: IntersectionTypeNodetypes: NodeArray<TypeNode>Returns: IntersectionTypeNode
**Parameters:** - `node`: `IntersectionTypeNode` - `types`: `NodeArray<TypeNode>` **Returns:** `IntersectionTypeNode`
(update-js-doc-augments-tag node-factory node)(update-js-doc-augments-tag node-factory node tag-name)(update-js-doc-augments-tag node-factory node tag-name class-name)(update-js-doc-augments-tag node-factory node tag-name class-name comment)Parameters:
node: JSDocAugmentsTagtag-name: Identifier | undefinedclass-name: ExpressionWithTypeArguments & { readonly expression: Identifier | PropertyAccessEntityNameExpression; }comment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocAugmentsTag
**Parameters:**
- `node`: `JSDocAugmentsTag`
- `tag-name`: `Identifier | undefined`
- `class-name`: `ExpressionWithTypeArguments & { readonly expression: Identifier | PropertyAccessEntityNameExpression; }`
- `comment`: `string | NodeArray<JSDocComment> | undefined`
**Returns:** `JSDocAugmentsTag`(update-js-doc-author-tag node-factory node)(update-js-doc-author-tag node-factory node tag-name)(update-js-doc-author-tag node-factory node tag-name comment)Parameters:
node: JSDocAuthorTagtag-name: Identifier | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocAuthorTag
**Parameters:** - `node`: `JSDocAuthorTag` - `tag-name`: `Identifier | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocAuthorTag`
(update-js-doc-callback-tag node-factory node)(update-js-doc-callback-tag node-factory node tag-name)(update-js-doc-callback-tag node-factory node tag-name type-expression)(update-js-doc-callback-tag node-factory
node
tag-name
type-expression
full-name)(update-js-doc-callback-tag node-factory
node
tag-name
type-expression
full-name
comment)Parameters:
node: JSDocCallbackTagtag-name: Identifier | undefinedtype-expression: JSDocSignaturefull-name: Identifier | JSDocNamespaceDeclaration | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocCallbackTag
**Parameters:** - `node`: `JSDocCallbackTag` - `tag-name`: `Identifier | undefined` - `type-expression`: `JSDocSignature` - `full-name`: `Identifier | JSDocNamespaceDeclaration | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocCallbackTag`
(update-js-doc-class-tag node-factory node)(update-js-doc-class-tag node-factory node tag-name)(update-js-doc-class-tag node-factory node tag-name comment)Parameters:
node: JSDocClassTagtag-name: Identifier | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocClassTag
**Parameters:** - `node`: `JSDocClassTag` - `tag-name`: `Identifier | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocClassTag`
(update-js-doc-comment node-factory node)(update-js-doc-comment node-factory node comment)(update-js-doc-comment node-factory node comment tags)Parameters:
node: JSDoccomment: string | NodeArray<JSDocComment> | undefinedtags: readonly JSDocTag[] | undefinedReturns: JSDoc
**Parameters:** - `node`: `JSDoc` - `comment`: `string | NodeArray<JSDocComment> | undefined` - `tags`: `readonly JSDocTag[] | undefined` **Returns:** `JSDoc`
(update-js-doc-deprecated-tag node-factory node)(update-js-doc-deprecated-tag node-factory node tag-name)(update-js-doc-deprecated-tag node-factory node tag-name comment)Parameters:
node: JSDocDeprecatedTagtag-name: Identifier | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocDeprecatedTag
**Parameters:** - `node`: `JSDocDeprecatedTag` - `tag-name`: `Identifier | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocDeprecatedTag`
(update-js-doc-enum-tag node-factory node)(update-js-doc-enum-tag node-factory node tag-name)(update-js-doc-enum-tag node-factory node tag-name type-expression)(update-js-doc-enum-tag node-factory node tag-name type-expression comment)Parameters:
node: JSDocEnumTagtag-name: Identifier | undefinedtype-expression: JSDocTypeExpressioncomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocEnumTag
**Parameters:** - `node`: `JSDocEnumTag` - `tag-name`: `Identifier | undefined` - `type-expression`: `JSDocTypeExpression` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocEnumTag`
(update-js-doc-function-type node-factory node parameters)(update-js-doc-function-type node-factory node parameters type)Parameters:
node: JSDocFunctionTypeparameters: readonly ParameterDeclaration[]type: TypeNode | undefinedReturns: JSDocFunctionType
**Parameters:** - `node`: `JSDocFunctionType` - `parameters`: `readonly ParameterDeclaration[]` - `type`: `TypeNode | undefined` **Returns:** `JSDocFunctionType`
(update-js-doc-implements-tag node-factory node)(update-js-doc-implements-tag node-factory node tag-name)(update-js-doc-implements-tag node-factory node tag-name class-name)(update-js-doc-implements-tag node-factory node tag-name class-name comment)Parameters:
node: JSDocImplementsTagtag-name: Identifier | undefinedclass-name: ExpressionWithTypeArguments & { readonly expression: Identifier | PropertyAccessEntityNameExpression; }comment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocImplementsTag
**Parameters:**
- `node`: `JSDocImplementsTag`
- `tag-name`: `Identifier | undefined`
- `class-name`: `ExpressionWithTypeArguments & { readonly expression: Identifier | PropertyAccessEntityNameExpression; }`
- `comment`: `string | NodeArray<JSDocComment> | undefined`
**Returns:** `JSDocImplementsTag`(update-js-doc-link node-factory node)(update-js-doc-link node-factory node name)(update-js-doc-link node-factory node name text)Parameters:
node: JSDocLinkname: EntityName | JSDocMemberName | undefinedtext: stringReturns: JSDocLink
**Parameters:** - `node`: `JSDocLink` - `name`: `EntityName | JSDocMemberName | undefined` - `text`: `string` **Returns:** `JSDocLink`
(update-js-doc-link-code node-factory node)(update-js-doc-link-code node-factory node name)(update-js-doc-link-code node-factory node name text)Parameters:
node: JSDocLinkCodename: EntityName | JSDocMemberName | undefinedtext: stringReturns: JSDocLinkCode
**Parameters:** - `node`: `JSDocLinkCode` - `name`: `EntityName | JSDocMemberName | undefined` - `text`: `string` **Returns:** `JSDocLinkCode`
(update-js-doc-link-plain node-factory node)(update-js-doc-link-plain node-factory node name)(update-js-doc-link-plain node-factory node name text)Parameters:
node: JSDocLinkPlainname: EntityName | JSDocMemberName | undefinedtext: stringReturns: JSDocLinkPlain
**Parameters:** - `node`: `JSDocLinkPlain` - `name`: `EntityName | JSDocMemberName | undefined` - `text`: `string` **Returns:** `JSDocLinkPlain`
(update-js-doc-member-name node-factory node left right)Parameters:
node: JSDocMemberNameleft: EntityName | JSDocMemberNameright: IdentifierReturns: JSDocMemberName
**Parameters:** - `node`: `JSDocMemberName` - `left`: `EntityName | JSDocMemberName` - `right`: `Identifier` **Returns:** `JSDocMemberName`
(update-js-doc-name-reference node-factory node name)Parameters:
node: JSDocNameReferencename: EntityName | JSDocMemberNameReturns: JSDocNameReference
**Parameters:** - `node`: `JSDocNameReference` - `name`: `EntityName | JSDocMemberName` **Returns:** `JSDocNameReference`
(update-js-doc-namepath-type node-factory node type)Parameters:
node: JSDocNamepathTypetype: TypeNodeReturns: JSDocNamepathType
**Parameters:** - `node`: `JSDocNamepathType` - `type`: `TypeNode` **Returns:** `JSDocNamepathType`
(update-js-doc-non-nullable-type node-factory node type)Parameters:
node: JSDocNonNullableTypetype: TypeNodeReturns: JSDocNonNullableType
**Parameters:** - `node`: `JSDocNonNullableType` - `type`: `TypeNode` **Returns:** `JSDocNonNullableType`
(update-js-doc-nullable-type node-factory node type)Parameters:
node: JSDocNullableTypetype: TypeNodeReturns: JSDocNullableType
**Parameters:** - `node`: `JSDocNullableType` - `type`: `TypeNode` **Returns:** `JSDocNullableType`
(update-js-doc-optional-type node-factory node type)Parameters:
node: JSDocOptionalTypetype: TypeNodeReturns: JSDocOptionalType
**Parameters:** - `node`: `JSDocOptionalType` - `type`: `TypeNode` **Returns:** `JSDocOptionalType`
(update-js-doc-overload-tag node-factory node)(update-js-doc-overload-tag node-factory node tag-name)(update-js-doc-overload-tag node-factory node tag-name type-expression)(update-js-doc-overload-tag node-factory node tag-name type-expression comment)Parameters:
node: JSDocOverloadTagtag-name: Identifier | undefinedtype-expression: JSDocSignaturecomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocOverloadTag
**Parameters:** - `node`: `JSDocOverloadTag` - `tag-name`: `Identifier | undefined` - `type-expression`: `JSDocSignature` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocOverloadTag`
(update-js-doc-override-tag node-factory node)(update-js-doc-override-tag node-factory node tag-name)(update-js-doc-override-tag node-factory node tag-name comment)Parameters:
node: JSDocOverrideTagtag-name: Identifier | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocOverrideTag
**Parameters:** - `node`: `JSDocOverrideTag` - `tag-name`: `Identifier | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocOverrideTag`
(update-js-doc-parameter-tag node-factory node)(update-js-doc-parameter-tag node-factory node tag-name)(update-js-doc-parameter-tag node-factory node tag-name name)(update-js-doc-parameter-tag node-factory node tag-name name bracketed?)(update-js-doc-parameter-tag node-factory
node
tag-name
name
bracketed?
type-expression)(update-js-doc-parameter-tag node-factory
node
tag-name
name
bracketed?
type-expression
name-first?)(update-js-doc-parameter-tag node-factory
node
tag-name
name
bracketed?
type-expression
name-first?
comment)Parameters:
node: JSDocParameterTagtag-name: Identifier | undefinedname: EntityNamebracketed?: booleantype-expression: JSDocTypeExpression | undefinedname-first?: booleancomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocParameterTag
**Parameters:** - `node`: `JSDocParameterTag` - `tag-name`: `Identifier | undefined` - `name`: `EntityName` - `bracketed?`: `boolean` - `type-expression`: `JSDocTypeExpression | undefined` - `name-first?`: `boolean` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocParameterTag`
(update-js-doc-private-tag node-factory node)(update-js-doc-private-tag node-factory node tag-name)(update-js-doc-private-tag node-factory node tag-name comment)Parameters:
node: JSDocPrivateTagtag-name: Identifier | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocPrivateTag
**Parameters:** - `node`: `JSDocPrivateTag` - `tag-name`: `Identifier | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocPrivateTag`
(update-js-doc-property-tag node-factory node)(update-js-doc-property-tag node-factory node tag-name)(update-js-doc-property-tag node-factory node tag-name name)(update-js-doc-property-tag node-factory node tag-name name bracketed?)(update-js-doc-property-tag node-factory
node
tag-name
name
bracketed?
type-expression)(update-js-doc-property-tag node-factory
node
tag-name
name
bracketed?
type-expression
name-first?)(update-js-doc-property-tag node-factory
node
tag-name
name
bracketed?
type-expression
name-first?
comment)Parameters:
node: JSDocPropertyTagtag-name: Identifier | undefinedname: EntityNamebracketed?: booleantype-expression: JSDocTypeExpression | undefinedname-first?: booleancomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocPropertyTag
**Parameters:** - `node`: `JSDocPropertyTag` - `tag-name`: `Identifier | undefined` - `name`: `EntityName` - `bracketed?`: `boolean` - `type-expression`: `JSDocTypeExpression | undefined` - `name-first?`: `boolean` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocPropertyTag`
(update-js-doc-protected-tag node-factory node)(update-js-doc-protected-tag node-factory node tag-name)(update-js-doc-protected-tag node-factory node tag-name comment)Parameters:
node: JSDocProtectedTagtag-name: Identifier | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocProtectedTag
**Parameters:** - `node`: `JSDocProtectedTag` - `tag-name`: `Identifier | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocProtectedTag`
(update-js-doc-public-tag node-factory node)(update-js-doc-public-tag node-factory node tag-name)(update-js-doc-public-tag node-factory node tag-name comment)Parameters:
node: JSDocPublicTagtag-name: Identifier | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocPublicTag
**Parameters:** - `node`: `JSDocPublicTag` - `tag-name`: `Identifier | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocPublicTag`
(update-js-doc-readonly-tag node-factory node)(update-js-doc-readonly-tag node-factory node tag-name)(update-js-doc-readonly-tag node-factory node tag-name comment)Parameters:
node: JSDocReadonlyTagtag-name: Identifier | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocReadonlyTag
**Parameters:** - `node`: `JSDocReadonlyTag` - `tag-name`: `Identifier | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocReadonlyTag`
(update-js-doc-return-tag node-factory node)(update-js-doc-return-tag node-factory node tag-name)(update-js-doc-return-tag node-factory node tag-name type-expression)(update-js-doc-return-tag node-factory node tag-name type-expression comment)Parameters:
node: JSDocReturnTagtag-name: Identifier | undefinedtype-expression: JSDocTypeExpression | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocReturnTag
**Parameters:** - `node`: `JSDocReturnTag` - `tag-name`: `Identifier | undefined` - `type-expression`: `JSDocTypeExpression | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocReturnTag`
(update-js-doc-satisfies-tag node-factory node)(update-js-doc-satisfies-tag node-factory node tag-name)(update-js-doc-satisfies-tag node-factory node tag-name type-expression)(update-js-doc-satisfies-tag node-factory node tag-name type-expression comment)Parameters:
node: JSDocSatisfiesTagtag-name: Identifier | undefinedtype-expression: JSDocTypeExpressioncomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocSatisfiesTag
**Parameters:** - `node`: `JSDocSatisfiesTag` - `tag-name`: `Identifier | undefined` - `type-expression`: `JSDocTypeExpression` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocSatisfiesTag`
(update-js-doc-see-tag node-factory node)(update-js-doc-see-tag node-factory node tag-name)(update-js-doc-see-tag node-factory node tag-name name-expression)(update-js-doc-see-tag node-factory node tag-name name-expression comment)Parameters:
node: JSDocSeeTagtag-name: Identifier | undefinedname-expression: JSDocNameReference | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocSeeTag
**Parameters:** - `node`: `JSDocSeeTag` - `tag-name`: `Identifier | undefined` - `name-expression`: `JSDocNameReference | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocSeeTag`
(update-js-doc-signature node-factory node)(update-js-doc-signature node-factory node type-parameters)(update-js-doc-signature node-factory node type-parameters parameters)(update-js-doc-signature node-factory node type-parameters parameters type)Parameters:
node: JSDocSignaturetype-parameters: readonly JSDocTemplateTag[] | undefinedparameters: readonly JSDocParameterTag[]type: JSDocReturnTag | undefinedReturns: JSDocSignature
**Parameters:** - `node`: `JSDocSignature` - `type-parameters`: `readonly JSDocTemplateTag[] | undefined` - `parameters`: `readonly JSDocParameterTag[]` - `type`: `JSDocReturnTag | undefined` **Returns:** `JSDocSignature`
(update-js-doc-template-tag node-factory node)(update-js-doc-template-tag node-factory node tag-name)(update-js-doc-template-tag node-factory node tag-name constraint)(update-js-doc-template-tag node-factory
node
tag-name
constraint
type-parameters)(update-js-doc-template-tag node-factory
node
tag-name
constraint
type-parameters
comment)Parameters:
node: JSDocTemplateTagtag-name: Identifier | undefinedconstraint: JSDocTypeExpression | undefinedtype-parameters: readonly TypeParameterDeclaration[]comment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocTemplateTag
**Parameters:** - `node`: `JSDocTemplateTag` - `tag-name`: `Identifier | undefined` - `constraint`: `JSDocTypeExpression | undefined` - `type-parameters`: `readonly TypeParameterDeclaration[]` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocTemplateTag`
(update-js-doc-text node-factory node text)Parameters:
node: JSDocTexttext: stringReturns: JSDocText
**Parameters:** - `node`: `JSDocText` - `text`: `string` **Returns:** `JSDocText`
(update-js-doc-this-tag node-factory node)(update-js-doc-this-tag node-factory node tag-name)(update-js-doc-this-tag node-factory node tag-name type-expression)(update-js-doc-this-tag node-factory node tag-name type-expression comment)Parameters:
node: JSDocThisTagtag-name: Identifier | undefinedtype-expression: JSDocTypeExpression | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocThisTag
**Parameters:** - `node`: `JSDocThisTag` - `tag-name`: `Identifier | undefined` - `type-expression`: `JSDocTypeExpression | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocThisTag`
(update-js-doc-throws-tag node-factory node)(update-js-doc-throws-tag node-factory node tag-name)(update-js-doc-throws-tag node-factory node tag-name type-expression)(update-js-doc-throws-tag node-factory node tag-name type-expression comment)Parameters:
node: JSDocThrowsTagtag-name: Identifier | undefinedtype-expression: JSDocTypeExpression | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocThrowsTag
**Parameters:** - `node`: `JSDocThrowsTag` - `tag-name`: `Identifier | undefined` - `type-expression`: `JSDocTypeExpression | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocThrowsTag`
(update-js-doc-type-expression node-factory node type)Parameters:
node: JSDocTypeExpressiontype: TypeNodeReturns: JSDocTypeExpression
**Parameters:** - `node`: `JSDocTypeExpression` - `type`: `TypeNode` **Returns:** `JSDocTypeExpression`
(update-js-doc-type-literal node-factory node)(update-js-doc-type-literal node-factory node js-doc-property-tags)(update-js-doc-type-literal node-factory node js-doc-property-tags array-type?)Parameters:
node: JSDocTypeLiteraljs-doc-property-tags: readonly JSDocPropertyLikeTag[] | undefinedarray-type?: boolean | undefinedReturns: JSDocTypeLiteral
**Parameters:** - `node`: `JSDocTypeLiteral` - `js-doc-property-tags`: `readonly JSDocPropertyLikeTag[] | undefined` - `array-type?`: `boolean | undefined` **Returns:** `JSDocTypeLiteral`
(update-js-doc-type-tag node-factory node)(update-js-doc-type-tag node-factory node tag-name)(update-js-doc-type-tag node-factory node tag-name type-expression)(update-js-doc-type-tag node-factory node tag-name type-expression comment)Parameters:
node: JSDocTypeTagtag-name: Identifier | undefinedtype-expression: JSDocTypeExpressioncomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocTypeTag
**Parameters:** - `node`: `JSDocTypeTag` - `tag-name`: `Identifier | undefined` - `type-expression`: `JSDocTypeExpression` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocTypeTag`
(update-js-doc-typedef-tag node-factory node)(update-js-doc-typedef-tag node-factory node tag-name)(update-js-doc-typedef-tag node-factory node tag-name type-expression)(update-js-doc-typedef-tag node-factory node tag-name type-expression full-name)(update-js-doc-typedef-tag node-factory
node
tag-name
type-expression
full-name
comment)Parameters:
node: JSDocTypedefTagtag-name: Identifier | undefinedtype-expression: JSDocTypeExpression | JSDocTypeLiteral | undefinedfull-name: Identifier | JSDocNamespaceDeclaration | undefinedcomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocTypedefTag
**Parameters:** - `node`: `JSDocTypedefTag` - `tag-name`: `Identifier | undefined` - `type-expression`: `JSDocTypeExpression | JSDocTypeLiteral | undefined` - `full-name`: `Identifier | JSDocNamespaceDeclaration | undefined` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocTypedefTag`
(update-js-doc-unknown-tag node-factory node tag-name)(update-js-doc-unknown-tag node-factory node tag-name comment)Parameters:
node: JSDocUnknownTagtag-name: Identifiercomment: string | NodeArray<JSDocComment> | undefinedReturns: JSDocUnknownTag
**Parameters:** - `node`: `JSDocUnknownTag` - `tag-name`: `Identifier` - `comment`: `string | NodeArray<JSDocComment> | undefined` **Returns:** `JSDocUnknownTag`
(update-js-doc-variadic-type node-factory node type)Parameters:
node: JSDocVariadicTypetype: TypeNodeReturns: JSDocVariadicType
**Parameters:** - `node`: `JSDocVariadicType` - `type`: `TypeNode` **Returns:** `JSDocVariadicType`
(update-jsx-attribute node-factory node name)(update-jsx-attribute node-factory node name initializer)Parameters:
node: JsxAttributename: JsxAttributeNameinitializer: JsxAttributeValue | undefinedReturns: JsxAttribute
**Parameters:** - `node`: `JsxAttribute` - `name`: `JsxAttributeName` - `initializer`: `JsxAttributeValue | undefined` **Returns:** `JsxAttribute`
(update-jsx-attributes node-factory node properties)Parameters:
node: JsxAttributesproperties: readonly JsxAttributeLike[]Returns: JsxAttributes
**Parameters:** - `node`: `JsxAttributes` - `properties`: `readonly JsxAttributeLike[]` **Returns:** `JsxAttributes`
(update-jsx-closing-element node-factory node tag-name)Parameters:
node: JsxClosingElementtag-name: JsxTagNameExpressionReturns: JsxClosingElement
**Parameters:** - `node`: `JsxClosingElement` - `tag-name`: `JsxTagNameExpression` **Returns:** `JsxClosingElement`
(update-jsx-element node-factory node opening-element children closing-element)Parameters:
node: JsxElementopening-element: JsxOpeningElementchildren: readonly JsxChild[]closing-element: JsxClosingElementReturns: JsxElement
**Parameters:** - `node`: `JsxElement` - `opening-element`: `JsxOpeningElement` - `children`: `readonly JsxChild[]` - `closing-element`: `JsxClosingElement` **Returns:** `JsxElement`
(update-jsx-expression node-factory node)(update-jsx-expression node-factory node expression)Parameters:
node: JsxExpressionexpression: Expression | undefinedReturns: JsxExpression
**Parameters:** - `node`: `JsxExpression` - `expression`: `Expression | undefined` **Returns:** `JsxExpression`
(update-jsx-fragment node-factory
node
opening-fragment
children
closing-fragment)Parameters:
node: JsxFragmentopening-fragment: JsxOpeningFragmentchildren: readonly JsxChild[]closing-fragment: JsxClosingFragmentReturns: JsxFragment
**Parameters:** - `node`: `JsxFragment` - `opening-fragment`: `JsxOpeningFragment` - `children`: `readonly JsxChild[]` - `closing-fragment`: `JsxClosingFragment` **Returns:** `JsxFragment`
(update-jsx-namespaced-name node-factory node namespace name)Parameters:
node: JsxNamespacedNamenamespace: Identifiername: IdentifierReturns: JsxNamespacedName
**Parameters:** - `node`: `JsxNamespacedName` - `namespace`: `Identifier` - `name`: `Identifier` **Returns:** `JsxNamespacedName`
(update-jsx-opening-element node-factory node tag-name)(update-jsx-opening-element node-factory node tag-name type-arguments)(update-jsx-opening-element node-factory
node
tag-name
type-arguments
attributes)Parameters:
node: JsxOpeningElementtag-name: JsxTagNameExpressiontype-arguments: readonly TypeNode[] | undefinedattributes: JsxAttributesReturns: JsxOpeningElement
**Parameters:** - `node`: `JsxOpeningElement` - `tag-name`: `JsxTagNameExpression` - `type-arguments`: `readonly TypeNode[] | undefined` - `attributes`: `JsxAttributes` **Returns:** `JsxOpeningElement`
(update-jsx-self-closing-element node-factory node tag-name)(update-jsx-self-closing-element node-factory node tag-name type-arguments)(update-jsx-self-closing-element node-factory
node
tag-name
type-arguments
attributes)Parameters:
node: JsxSelfClosingElementtag-name: JsxTagNameExpressiontype-arguments: readonly TypeNode[] | undefinedattributes: JsxAttributesReturns: JsxSelfClosingElement
**Parameters:** - `node`: `JsxSelfClosingElement` - `tag-name`: `JsxTagNameExpression` - `type-arguments`: `readonly TypeNode[] | undefined` - `attributes`: `JsxAttributes` **Returns:** `JsxSelfClosingElement`
(update-jsx-spread-attribute node-factory node expression)Parameters:
node: JsxSpreadAttributeexpression: ExpressionReturns: JsxSpreadAttribute
**Parameters:** - `node`: `JsxSpreadAttribute` - `expression`: `Expression` **Returns:** `JsxSpreadAttribute`
(update-jsx-text node-factory node text)(update-jsx-text node-factory node text contains-only-trivia-white-spaces?)Parameters:
node: JsxTexttext: stringcontains-only-trivia-white-spaces?: boolean | undefinedReturns: JsxText
**Parameters:** - `node`: `JsxText` - `text`: `string` - `contains-only-trivia-white-spaces?`: `boolean | undefined` **Returns:** `JsxText`
(update-labeled-statement node-factory node label statement)Parameters:
node: LabeledStatementlabel: Identifierstatement: StatementReturns: LabeledStatement
**Parameters:** - `node`: `LabeledStatement` - `label`: `Identifier` - `statement`: `Statement` **Returns:** `LabeledStatement`
(update-literal-type-node node-factory node literal)Parameters:
node: LiteralTypeNodeliteral: LiteralExpression | NullLiteral | BooleanLiteral | PrefixUnaryExpressionReturns: LiteralTypeNode
**Parameters:** - `node`: `LiteralTypeNode` - `literal`: `LiteralExpression | NullLiteral | BooleanLiteral | PrefixUnaryExpression` **Returns:** `LiteralTypeNode`
(update-mapped-type-node node-factory node)(update-mapped-type-node node-factory node readonly-token)(update-mapped-type-node node-factory node readonly-token type-parameter)(update-mapped-type-node node-factory
node
readonly-token
type-parameter
name-type)(update-mapped-type-node node-factory
node
readonly-token
type-parameter
name-type
question-token)(update-mapped-type-node node-factory
node
readonly-token
type-parameter
name-type
question-token
type)(update-mapped-type-node node-factory
node
readonly-token
type-parameter
name-type
question-token
type
members)Parameters:
node: MappedTypeNodereadonly-token: ReadonlyKeyword | PlusToken | MinusToken | undefinedtype-parameter: TypeParameterDeclarationname-type: TypeNode | undefinedquestion-token: QuestionToken | PlusToken | MinusToken | undefinedtype: TypeNode | undefinedmembers: NodeArray<TypeElement> | undefinedReturns: MappedTypeNode
**Parameters:** - `node`: `MappedTypeNode` - `readonly-token`: `ReadonlyKeyword | PlusToken | MinusToken | undefined` - `type-parameter`: `TypeParameterDeclaration` - `name-type`: `TypeNode | undefined` - `question-token`: `QuestionToken | PlusToken | MinusToken | undefined` - `type`: `TypeNode | undefined` - `members`: `NodeArray<TypeElement> | undefined` **Returns:** `MappedTypeNode`
(update-meta-property node-factory node name)Parameters:
node: MetaPropertyname: IdentifierReturns: MetaProperty
**Parameters:** - `node`: `MetaProperty` - `name`: `Identifier` **Returns:** `MetaProperty`
(update-method-declaration node-factory node)(update-method-declaration node-factory node modifiers)(update-method-declaration node-factory node modifiers asterisk-token)(update-method-declaration node-factory node modifiers asterisk-token name)(update-method-declaration node-factory
node
modifiers
asterisk-token
name
question-token)(update-method-declaration node-factory
node
modifiers
asterisk-token
name
question-token
type-parameters)(update-method-declaration node-factory
node
modifiers
asterisk-token
name
question-token
type-parameters
parameters)(update-method-declaration node-factory
node
modifiers
asterisk-token
name
question-token
type-parameters
parameters
type)(update-method-declaration node-factory
node
modifiers
asterisk-token
name
question-token
type-parameters
parameters
type
body)Parameters:
node: MethodDeclarationmodifiers: readonly ModifierLike[] | undefinedasterisk-token: AsteriskToken | undefinedname: PropertyNamequestion-token: QuestionToken | undefinedtype-parameters: readonly TypeParameterDeclaration[] | undefinedparameters: readonly ParameterDeclaration[]type: TypeNode | undefinedbody: Block | undefinedReturns: MethodDeclaration
**Parameters:** - `node`: `MethodDeclaration` - `modifiers`: `readonly ModifierLike[] | undefined` - `asterisk-token`: `AsteriskToken | undefined` - `name`: `PropertyName` - `question-token`: `QuestionToken | undefined` - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `parameters`: `readonly ParameterDeclaration[]` - `type`: `TypeNode | undefined` - `body`: `Block | undefined` **Returns:** `MethodDeclaration`
(update-method-signature node-factory node)(update-method-signature node-factory node modifiers)(update-method-signature node-factory node modifiers name)(update-method-signature node-factory node modifiers name question-token)(update-method-signature node-factory
node
modifiers
name
question-token
type-parameters)(update-method-signature node-factory
node
modifiers
name
question-token
type-parameters
parameters)(update-method-signature node-factory
node
modifiers
name
question-token
type-parameters
parameters
type)Parameters:
node: MethodSignaturemodifiers: readonly Modifier[] | undefinedname: PropertyNamequestion-token: QuestionToken | undefinedtype-parameters: NodeArray<TypeParameterDeclaration> | undefinedparameters: NodeArray<ParameterDeclaration>type: TypeNode | undefinedReturns: MethodSignature
**Parameters:** - `node`: `MethodSignature` - `modifiers`: `readonly Modifier[] | undefined` - `name`: `PropertyName` - `question-token`: `QuestionToken | undefined` - `type-parameters`: `NodeArray<TypeParameterDeclaration> | undefined` - `parameters`: `NodeArray<ParameterDeclaration>` - `type`: `TypeNode | undefined` **Returns:** `MethodSignature`
(update-module-block node-factory node statements)Parameters:
node: ModuleBlockstatements: readonly Statement[]Returns: ModuleBlock
**Parameters:** - `node`: `ModuleBlock` - `statements`: `readonly Statement[]` **Returns:** `ModuleBlock`
(update-module-declaration node-factory node)(update-module-declaration node-factory node modifiers)(update-module-declaration node-factory node modifiers name)(update-module-declaration node-factory node modifiers name body)Parameters:
node: ModuleDeclarationmodifiers: readonly ModifierLike[] | undefinedname: ModuleNamebody: ModuleBody | undefinedReturns: ModuleDeclaration
**Parameters:** - `node`: `ModuleDeclaration` - `modifiers`: `readonly ModifierLike[] | undefined` - `name`: `ModuleName` - `body`: `ModuleBody | undefined` **Returns:** `ModuleDeclaration`
(update-named-exports node-factory node elements)Parameters:
node: NamedExportselements: readonly ExportSpecifier[]Returns: NamedExports
**Parameters:** - `node`: `NamedExports` - `elements`: `readonly ExportSpecifier[]` **Returns:** `NamedExports`
(update-named-imports node-factory node elements)Parameters:
node: NamedImportselements: readonly ImportSpecifier[]Returns: NamedImports
**Parameters:** - `node`: `NamedImports` - `elements`: `readonly ImportSpecifier[]` **Returns:** `NamedImports`
(update-named-tuple-member node-factory node)(update-named-tuple-member node-factory node dot-dot-dot-token)(update-named-tuple-member node-factory node dot-dot-dot-token name)(update-named-tuple-member node-factory
node
dot-dot-dot-token
name
question-token)(update-named-tuple-member node-factory
node
dot-dot-dot-token
name
question-token
type)Parameters:
node: NamedTupleMemberdot-dot-dot-token: DotDotDotToken | undefinedname: Identifierquestion-token: QuestionToken | undefinedtype: TypeNodeReturns: NamedTupleMember
**Parameters:** - `node`: `NamedTupleMember` - `dot-dot-dot-token`: `DotDotDotToken | undefined` - `name`: `Identifier` - `question-token`: `QuestionToken | undefined` - `type`: `TypeNode` **Returns:** `NamedTupleMember`
(update-namespace-export node-factory node name)Parameters:
node: NamespaceExportname: IdentifierReturns: NamespaceExport
**Parameters:** - `node`: `NamespaceExport` - `name`: `Identifier` **Returns:** `NamespaceExport`
(update-namespace-export-declaration node-factory node name)Parameters:
node: NamespaceExportDeclarationname: IdentifierReturns: NamespaceExportDeclaration
**Parameters:** - `node`: `NamespaceExportDeclaration` - `name`: `Identifier` **Returns:** `NamespaceExportDeclaration`
(update-namespace-import node-factory node name)Parameters:
node: NamespaceImportname: IdentifierReturns: NamespaceImport
**Parameters:** - `node`: `NamespaceImport` - `name`: `Identifier` **Returns:** `NamespaceImport`
(update-new-expression node-factory node expression)(update-new-expression node-factory node expression type-arguments)(update-new-expression node-factory
node
expression
type-arguments
arguments-array)Parameters:
node: NewExpressionexpression: Expressiontype-arguments: readonly TypeNode[] | undefinedarguments-array: readonly Expression[] | undefinedReturns: NewExpression
**Parameters:** - `node`: `NewExpression` - `expression`: `Expression` - `type-arguments`: `readonly TypeNode[] | undefined` - `arguments-array`: `readonly Expression[] | undefined` **Returns:** `NewExpression`
(update-non-null-chain node-factory node expression)Parameters:
node: NonNullChainexpression: ExpressionReturns: NonNullChain
**Parameters:** - `node`: `NonNullChain` - `expression`: `Expression` **Returns:** `NonNullChain`
(update-non-null-expression node-factory node expression)Parameters:
node: NonNullExpressionexpression: ExpressionReturns: NonNullExpression
**Parameters:** - `node`: `NonNullExpression` - `expression`: `Expression` **Returns:** `NonNullExpression`
(update-object-binding-pattern node-factory node elements)Parameters:
node: ObjectBindingPatternelements: readonly BindingElement[]Returns: ObjectBindingPattern
**Parameters:** - `node`: `ObjectBindingPattern` - `elements`: `readonly BindingElement[]` **Returns:** `ObjectBindingPattern`
(update-object-literal-expression node-factory node properties)Parameters:
node: ObjectLiteralExpressionproperties: readonly ObjectLiteralElementLike[]Returns: ObjectLiteralExpression
**Parameters:** - `node`: `ObjectLiteralExpression` - `properties`: `readonly ObjectLiteralElementLike[]` **Returns:** `ObjectLiteralExpression`
(update-optional-type-node node-factory node type)Parameters:
node: OptionalTypeNodetype: TypeNodeReturns: OptionalTypeNode
**Parameters:** - `node`: `OptionalTypeNode` - `type`: `TypeNode` **Returns:** `OptionalTypeNode`
(update-parameter-declaration node-factory node)(update-parameter-declaration node-factory node modifiers)(update-parameter-declaration node-factory node modifiers dot-dot-dot-token)(update-parameter-declaration node-factory
node
modifiers
dot-dot-dot-token
name)(update-parameter-declaration node-factory
node
modifiers
dot-dot-dot-token
name
question-token)(update-parameter-declaration node-factory
node
modifiers
dot-dot-dot-token
name
question-token
type)(update-parameter-declaration node-factory
node
modifiers
dot-dot-dot-token
name
question-token
type
initializer)Parameters:
node: ParameterDeclarationmodifiers: readonly ModifierLike[] | undefineddot-dot-dot-token: DotDotDotToken | undefinedname: string | BindingNamequestion-token: QuestionToken | undefinedtype: TypeNode | undefinedinitializer: Expression | undefinedReturns: ParameterDeclaration
**Parameters:** - `node`: `ParameterDeclaration` - `modifiers`: `readonly ModifierLike[] | undefined` - `dot-dot-dot-token`: `DotDotDotToken | undefined` - `name`: `string | BindingName` - `question-token`: `QuestionToken | undefined` - `type`: `TypeNode | undefined` - `initializer`: `Expression | undefined` **Returns:** `ParameterDeclaration`
(update-parenthesized-expression node-factory node expression)Parameters:
node: ParenthesizedExpressionexpression: ExpressionReturns: ParenthesizedExpression
**Parameters:** - `node`: `ParenthesizedExpression` - `expression`: `Expression` **Returns:** `ParenthesizedExpression`
(update-parenthesized-type node-factory node type)Parameters:
node: ParenthesizedTypeNodetype: TypeNodeReturns: ParenthesizedTypeNode
**Parameters:** - `node`: `ParenthesizedTypeNode` - `type`: `TypeNode` **Returns:** `ParenthesizedTypeNode`
(update-partially-emitted-expression node-factory node expression)Parameters:
node: PartiallyEmittedExpressionexpression: ExpressionReturns: PartiallyEmittedExpression
**Parameters:** - `node`: `PartiallyEmittedExpression` - `expression`: `Expression` **Returns:** `PartiallyEmittedExpression`
(update-postfix-unary-expression node-factory node operand)Parameters:
node: PostfixUnaryExpressionoperand: ExpressionReturns: PostfixUnaryExpression
**Parameters:** - `node`: `PostfixUnaryExpression` - `operand`: `Expression` **Returns:** `PostfixUnaryExpression`
(update-prefix-unary-expression node-factory node operand)Parameters:
node: PrefixUnaryExpressionoperand: ExpressionReturns: PrefixUnaryExpression
**Parameters:** - `node`: `PrefixUnaryExpression` - `operand`: `Expression` **Returns:** `PrefixUnaryExpression`
(update-property-access-chain node-factory node expression)(update-property-access-chain node-factory node expression question-dot-token)(update-property-access-chain node-factory
node
expression
question-dot-token
name)Parameters:
node: PropertyAccessChainexpression: Expressionquestion-dot-token: QuestionDotToken | undefinedname: MemberNameReturns: PropertyAccessChain
**Parameters:** - `node`: `PropertyAccessChain` - `expression`: `Expression` - `question-dot-token`: `QuestionDotToken | undefined` - `name`: `MemberName` **Returns:** `PropertyAccessChain`
(update-property-access-expression node-factory node expression name)Parameters:
node: PropertyAccessExpressionexpression: Expressionname: MemberNameReturns: PropertyAccessExpression
**Parameters:** - `node`: `PropertyAccessExpression` - `expression`: `Expression` - `name`: `MemberName` **Returns:** `PropertyAccessExpression`
(update-property-assignment node-factory node name initializer)Parameters:
node: PropertyAssignmentname: PropertyNameinitializer: ExpressionReturns: PropertyAssignment
**Parameters:** - `node`: `PropertyAssignment` - `name`: `PropertyName` - `initializer`: `Expression` **Returns:** `PropertyAssignment`
(update-property-declaration node-factory node)(update-property-declaration node-factory node modifiers)(update-property-declaration node-factory node modifiers name)(update-property-declaration node-factory
node
modifiers
name
question-or-exclamation-token)(update-property-declaration node-factory
node
modifiers
name
question-or-exclamation-token
type)(update-property-declaration node-factory
node
modifiers
name
question-or-exclamation-token
type
initializer)Parameters:
node: PropertyDeclarationmodifiers: readonly ModifierLike[] | undefinedname: string | PropertyNamequestion-or-exclamation-token: QuestionToken | ExclamationToken | undefinedtype: TypeNode | undefinedinitializer: Expression | undefinedReturns: PropertyDeclaration
**Parameters:** - `node`: `PropertyDeclaration` - `modifiers`: `readonly ModifierLike[] | undefined` - `name`: `string | PropertyName` - `question-or-exclamation-token`: `QuestionToken | ExclamationToken | undefined` - `type`: `TypeNode | undefined` - `initializer`: `Expression | undefined` **Returns:** `PropertyDeclaration`
(update-property-signature node-factory node)(update-property-signature node-factory node modifiers)(update-property-signature node-factory node modifiers name)(update-property-signature node-factory node modifiers name question-token)(update-property-signature node-factory node modifiers name question-token type)Parameters:
node: PropertySignaturemodifiers: readonly Modifier[] | undefinedname: PropertyNamequestion-token: QuestionToken | undefinedtype: TypeNode | undefinedReturns: PropertySignature
**Parameters:** - `node`: `PropertySignature` - `modifiers`: `readonly Modifier[] | undefined` - `name`: `PropertyName` - `question-token`: `QuestionToken | undefined` - `type`: `TypeNode | undefined` **Returns:** `PropertySignature`
(update-qualified-name node-factory node left right)Parameters:
node: QualifiedNameleft: EntityNameright: IdentifierReturns: QualifiedName
**Parameters:** - `node`: `QualifiedName` - `left`: `EntityName` - `right`: `Identifier` **Returns:** `QualifiedName`
(update-rest-type-node node-factory node type)Parameters:
node: RestTypeNodetype: TypeNodeReturns: RestTypeNode
**Parameters:** - `node`: `RestTypeNode` - `type`: `TypeNode` **Returns:** `RestTypeNode`
(update-return-statement node-factory node)(update-return-statement node-factory node expression)Parameters:
node: ReturnStatementexpression: Expression | undefinedReturns: ReturnStatement
**Parameters:** - `node`: `ReturnStatement` - `expression`: `Expression | undefined` **Returns:** `ReturnStatement`
(update-satisfies-expression node-factory node expression type)Parameters:
node: SatisfiesExpressionexpression: Expressiontype: TypeNodeReturns: SatisfiesExpression
**Parameters:** - `node`: `SatisfiesExpression` - `expression`: `Expression` - `type`: `TypeNode` **Returns:** `SatisfiesExpression`
(update-set-accessor-declaration node-factory node)(update-set-accessor-declaration node-factory node modifiers)(update-set-accessor-declaration node-factory node modifiers name)(update-set-accessor-declaration node-factory node modifiers name parameters)(update-set-accessor-declaration node-factory
node
modifiers
name
parameters
body)Parameters:
node: SetAccessorDeclarationmodifiers: readonly ModifierLike[] | undefinedname: PropertyNameparameters: readonly ParameterDeclaration[]body: Block | undefinedReturns: SetAccessorDeclaration
**Parameters:** - `node`: `SetAccessorDeclaration` - `modifiers`: `readonly ModifierLike[] | undefined` - `name`: `PropertyName` - `parameters`: `readonly ParameterDeclaration[]` - `body`: `Block | undefined` **Returns:** `SetAccessorDeclaration`
(update-shorthand-property-assignment node-factory node name)(update-shorthand-property-assignment node-factory
node
name
object-assignment-initializer)Parameters:
node: ShorthandPropertyAssignmentname: Identifierobject-assignment-initializer: Expression | undefinedReturns: ShorthandPropertyAssignment
**Parameters:** - `node`: `ShorthandPropertyAssignment` - `name`: `Identifier` - `object-assignment-initializer`: `Expression | undefined` **Returns:** `ShorthandPropertyAssignment`
(update-source-file node-factory node statements)(update-source-file node-factory node statements declaration-file?)(update-source-file node-factory
node
statements
declaration-file?
referenced-files)(update-source-file node-factory
node
statements
declaration-file?
referenced-files
type-references)(update-source-file node-factory
node
statements
declaration-file?
referenced-files
type-references
has-no-default-lib?)(update-source-file node-factory
node
statements
declaration-file?
referenced-files
type-references
has-no-default-lib?
lib-references)Parameters:
node: SourceFilestatements: readonly Statement[]declaration-file?: boolean | undefinedreferenced-files: readonly FileReference[] | undefinedtype-references: readonly FileReference[] | undefinedhas-no-default-lib?: boolean | undefinedlib-references: readonly FileReference[] | undefinedReturns: SourceFile
**Parameters:** - `node`: `SourceFile` - `statements`: `readonly Statement[]` - `declaration-file?`: `boolean | undefined` - `referenced-files`: `readonly FileReference[] | undefined` - `type-references`: `readonly FileReference[] | undefined` - `has-no-default-lib?`: `boolean | undefined` - `lib-references`: `readonly FileReference[] | undefined` **Returns:** `SourceFile`
(update-spread-assignment node-factory node expression)Parameters:
node: SpreadAssignmentexpression: ExpressionReturns: SpreadAssignment
**Parameters:** - `node`: `SpreadAssignment` - `expression`: `Expression` **Returns:** `SpreadAssignment`
(update-spread-element node-factory node expression)Parameters:
node: SpreadElementexpression: ExpressionReturns: SpreadElement
**Parameters:** - `node`: `SpreadElement` - `expression`: `Expression` **Returns:** `SpreadElement`
(update-switch-statement node-factory node expression case-block)Parameters:
node: SwitchStatementexpression: Expressioncase-block: CaseBlockReturns: SwitchStatement
**Parameters:** - `node`: `SwitchStatement` - `expression`: `Expression` - `case-block`: `CaseBlock` **Returns:** `SwitchStatement`
(update-tagged-template-expression node-factory node tag)(update-tagged-template-expression node-factory node tag type-arguments)(update-tagged-template-expression node-factory
node
tag
type-arguments
template)Parameters:
node: TaggedTemplateExpressiontag: Expressiontype-arguments: readonly TypeNode[] | undefinedtemplate: TemplateLiteralReturns: TaggedTemplateExpression
**Parameters:** - `node`: `TaggedTemplateExpression` - `tag`: `Expression` - `type-arguments`: `readonly TypeNode[] | undefined` - `template`: `TemplateLiteral` **Returns:** `TaggedTemplateExpression`
(update-template-expression node-factory node head template-spans)Parameters:
node: TemplateExpressionhead: TemplateHeadtemplate-spans: readonly TemplateSpan[]Returns: TemplateExpression
**Parameters:** - `node`: `TemplateExpression` - `head`: `TemplateHead` - `template-spans`: `readonly TemplateSpan[]` **Returns:** `TemplateExpression`
(update-template-literal-type node-factory node head template-spans)Parameters:
node: TemplateLiteralTypeNodehead: TemplateHeadtemplate-spans: readonly TemplateLiteralTypeSpan[]Returns: TemplateLiteralTypeNode
**Parameters:** - `node`: `TemplateLiteralTypeNode` - `head`: `TemplateHead` - `template-spans`: `readonly TemplateLiteralTypeSpan[]` **Returns:** `TemplateLiteralTypeNode`
(update-template-literal-type-span node-factory node type literal)Parameters:
node: TemplateLiteralTypeSpantype: TypeNodeliteral: TemplateMiddle | TemplateTailReturns: TemplateLiteralTypeSpan
**Parameters:** - `node`: `TemplateLiteralTypeSpan` - `type`: `TypeNode` - `literal`: `TemplateMiddle | TemplateTail` **Returns:** `TemplateLiteralTypeSpan`
(update-template-span node-factory node expression literal)Parameters:
node: TemplateSpanexpression: Expressionliteral: TemplateMiddle | TemplateTailReturns: TemplateSpan
**Parameters:** - `node`: `TemplateSpan` - `expression`: `Expression` - `literal`: `TemplateMiddle | TemplateTail` **Returns:** `TemplateSpan`
(update-throw-statement node-factory node expression)Parameters:
node: ThrowStatementexpression: ExpressionReturns: ThrowStatement
**Parameters:** - `node`: `ThrowStatement` - `expression`: `Expression` **Returns:** `ThrowStatement`
(update-try-statement node-factory node try-block)(update-try-statement node-factory node try-block catch-clause)(update-try-statement node-factory node try-block catch-clause finally-block)Parameters:
node: TryStatementtry-block: Blockcatch-clause: CatchClause | undefinedfinally-block: Block | undefinedReturns: TryStatement
**Parameters:** - `node`: `TryStatement` - `try-block`: `Block` - `catch-clause`: `CatchClause | undefined` - `finally-block`: `Block | undefined` **Returns:** `TryStatement`
(update-tuple-type-node node-factory node elements)Parameters:
node: TupleTypeNodeelements: readonly (TypeNode | NamedTupleMember)[]Returns: TupleTypeNode
**Parameters:** - `node`: `TupleTypeNode` - `elements`: `readonly (TypeNode | NamedTupleMember)[]` **Returns:** `TupleTypeNode`
(update-type-alias-declaration node-factory node)(update-type-alias-declaration node-factory node modifiers)(update-type-alias-declaration node-factory node modifiers name)(update-type-alias-declaration node-factory node modifiers name type-parameters)(update-type-alias-declaration node-factory
node
modifiers
name
type-parameters
type)Parameters:
node: TypeAliasDeclarationmodifiers: readonly ModifierLike[] | undefinedname: Identifiertype-parameters: readonly TypeParameterDeclaration[] | undefinedtype: TypeNodeReturns: TypeAliasDeclaration
**Parameters:** - `node`: `TypeAliasDeclaration` - `modifiers`: `readonly ModifierLike[] | undefined` - `name`: `Identifier` - `type-parameters`: `readonly TypeParameterDeclaration[] | undefined` - `type`: `TypeNode` **Returns:** `TypeAliasDeclaration`
(update-type-assertion node-factory node type expression)Parameters:
node: TypeAssertiontype: TypeNodeexpression: ExpressionReturns: TypeAssertion
**Parameters:** - `node`: `TypeAssertion` - `type`: `TypeNode` - `expression`: `Expression` **Returns:** `TypeAssertion`
(update-type-literal-node node-factory node members)Parameters:
node: TypeLiteralNodemembers: NodeArray<TypeElement>Returns: TypeLiteralNode
**Parameters:** - `node`: `TypeLiteralNode` - `members`: `NodeArray<TypeElement>` **Returns:** `TypeLiteralNode`
(update-type-of-expression node-factory node expression)Parameters:
node: TypeOfExpressionexpression: ExpressionReturns: TypeOfExpression
**Parameters:** - `node`: `TypeOfExpression` - `expression`: `Expression` **Returns:** `TypeOfExpression`
(update-type-operator-node node-factory node type)Parameters:
node: TypeOperatorNodetype: TypeNodeReturns: TypeOperatorNode
**Parameters:** - `node`: `TypeOperatorNode` - `type`: `TypeNode` **Returns:** `TypeOperatorNode`
(update-type-parameter-declaration node-factory node)(update-type-parameter-declaration node-factory node modifiers)(update-type-parameter-declaration node-factory node modifiers name)(update-type-parameter-declaration node-factory node modifiers name constraint)(update-type-parameter-declaration node-factory
node
modifiers
name
constraint
default-type)Parameters:
node: TypeParameterDeclarationmodifiers: readonly Modifier[] | undefinedname: Identifierconstraint: TypeNode | undefineddefault-type: TypeNode | undefinedReturns: TypeParameterDeclaration
**Parameters:** - `node`: `TypeParameterDeclaration` - `modifiers`: `readonly Modifier[] | undefined` - `name`: `Identifier` - `constraint`: `TypeNode | undefined` - `default-type`: `TypeNode | undefined` **Returns:** `TypeParameterDeclaration`
(update-type-predicate-node node-factory node)(update-type-predicate-node node-factory node asserts-modifier)(update-type-predicate-node node-factory node asserts-modifier parameter-name)(update-type-predicate-node node-factory
node
asserts-modifier
parameter-name
type)Parameters:
node: TypePredicateNodeasserts-modifier: AssertsKeyword | undefinedparameter-name: Identifier | ThisTypeNodetype: TypeNode | undefinedReturns: TypePredicateNode
**Parameters:** - `node`: `TypePredicateNode` - `asserts-modifier`: `AssertsKeyword | undefined` - `parameter-name`: `Identifier | ThisTypeNode` - `type`: `TypeNode | undefined` **Returns:** `TypePredicateNode`
(update-type-query-node node-factory node expr-name)(update-type-query-node node-factory node expr-name type-arguments)Parameters:
node: TypeQueryNodeexpr-name: EntityNametype-arguments: readonly TypeNode[] | undefinedReturns: TypeQueryNode
**Parameters:** - `node`: `TypeQueryNode` - `expr-name`: `EntityName` - `type-arguments`: `readonly TypeNode[] | undefined` **Returns:** `TypeQueryNode`
(update-type-reference-node node-factory node type-name)(update-type-reference-node node-factory node type-name type-arguments)Parameters:
node: TypeReferenceNodetype-name: EntityNametype-arguments: NodeArray<TypeNode> | undefinedReturns: TypeReferenceNode
**Parameters:** - `node`: `TypeReferenceNode` - `type-name`: `EntityName` - `type-arguments`: `NodeArray<TypeNode> | undefined` **Returns:** `TypeReferenceNode`
(update-union-type-node node-factory node types)Parameters:
node: UnionTypeNodetypes: NodeArray<TypeNode>Returns: UnionTypeNode
**Parameters:** - `node`: `UnionTypeNode` - `types`: `NodeArray<TypeNode>` **Returns:** `UnionTypeNode`
(update-variable-declaration node-factory node name)(update-variable-declaration node-factory node name exclamation-token)(update-variable-declaration node-factory node name exclamation-token type)(update-variable-declaration node-factory
node
name
exclamation-token
type
initializer)Parameters:
node: VariableDeclarationname: BindingNameexclamation-token: ExclamationToken | undefinedtype: TypeNode | undefinedinitializer: Expression | undefinedReturns: VariableDeclaration
**Parameters:** - `node`: `VariableDeclaration` - `name`: `BindingName` - `exclamation-token`: `ExclamationToken | undefined` - `type`: `TypeNode | undefined` - `initializer`: `Expression | undefined` **Returns:** `VariableDeclaration`
(update-variable-declaration-list node-factory node declarations)Parameters:
node: VariableDeclarationListdeclarations: readonly VariableDeclaration[]Returns: VariableDeclarationList
**Parameters:** - `node`: `VariableDeclarationList` - `declarations`: `readonly VariableDeclaration[]` **Returns:** `VariableDeclarationList`
(update-variable-statement node-factory node)(update-variable-statement node-factory node modifiers)(update-variable-statement node-factory node modifiers declaration-list)Parameters:
node: VariableStatementmodifiers: readonly ModifierLike[] | undefineddeclaration-list: VariableDeclarationListReturns: VariableStatement
**Parameters:** - `node`: `VariableStatement` - `modifiers`: `readonly ModifierLike[] | undefined` - `declaration-list`: `VariableDeclarationList` **Returns:** `VariableStatement`
(update-void-expression node-factory node expression)Parameters:
node: VoidExpressionexpression: ExpressionReturns: VoidExpression
**Parameters:** - `node`: `VoidExpression` - `expression`: `Expression` **Returns:** `VoidExpression`
(update-while-statement node-factory node expression statement)Parameters:
node: WhileStatementexpression: Expressionstatement: StatementReturns: WhileStatement
**Parameters:** - `node`: `WhileStatement` - `expression`: `Expression` - `statement`: `Statement` **Returns:** `WhileStatement`
(update-with-statement node-factory node expression statement)Parameters:
node: WithStatementexpression: Expressionstatement: StatementReturns: WithStatement
**Parameters:** - `node`: `WithStatement` - `expression`: `Expression` - `statement`: `Statement` **Returns:** `WithStatement`
(update-yield-expression node-factory node)(update-yield-expression node-factory node asterisk-token)(update-yield-expression node-factory node asterisk-token expression)Parameters:
node: YieldExpressionasterisk-token: AsteriskToken | undefinedexpression: Expression | undefinedReturns: YieldExpression
**Parameters:** - `node`: `YieldExpression` - `asterisk-token`: `AsteriskToken | undefined` - `expression`: `Expression | undefined` **Returns:** `YieldExpression`
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |