Interface InstanceofExpression

interface InstanceofExpression {
    compilerNode: tsc.InstanceofExpression;
    appendWhitespace(textOrWriterFunction: string | WriterFunction): void;
    asKind<TKind extends tsc.SyntaxKind>(
        kind: TKind,
    ): KindToNodeMappings[TKind] | undefined;
    asKindOrThrow<TKind extends tsc.SyntaxKind>(
        kind: TKind,
        message?: string | (() => string),
    ): KindToNodeMappings[TKind];
    containsRange(pos: number, end: number): boolean;
    forEachChild<T>(
        cbNode: (node: Node) => T | undefined,
        cbNodeArray?: (nodes: Node<tsc.Node>[]) => T | undefined,
    ): T | undefined;
    forEachChildAsArray(): Node<tsc.Node>[];
    forEachDescendant<T>(
        cbNode: (
            node: Node,
            traversal: ForEachDescendantTraversalControl,
        ) => T | undefined,
        cbNodeArray?: (
            nodes: Node<tsc.Node>[],
            traversal: ForEachDescendantTraversalControl,
        ) => T | undefined,
    ): T | undefined;
    forEachDescendantAsArray(): Node<tsc.Node>[];
    forget(): void;
    forgetDescendants(): void;
    formatText(settings?: FormatCodeSettings): void;
    getAncestors(): Node<tsc.Node>[];
    getChildAtIndex(index: number): Node;
    getChildAtIndexIfKind<TKind extends tsc.SyntaxKind>(
        index: number,
        kind: TKind,
    ): KindToNodeMappings[TKind] | undefined;
    getChildAtIndexIfKindOrThrow<TKind extends tsc.SyntaxKind>(
        index: number,
        kind: TKind,
        message?: string | (() => string),
    ): KindToNodeMappings[TKind];
    getChildAtPos(pos: number): Node<tsc.Node> | undefined;
    getChildCount(): number;
    getChildIndentationLevel(): number;
    getChildIndentationText(offset?: number): string;
    getChildIndex(): number;
    getChildren(): Node<tsc.Node>[];
    getChildrenOfKind<TKind extends tsc.SyntaxKind>(
        kind: TKind,
    ): KindToNodeMappings[TKind][];
    getChildSyntaxList(): SyntaxList | undefined;
    getChildSyntaxListOrThrow(message?: string | (() => string)): SyntaxList;
    getCombinedModifierFlags(): ModifierFlags;
    getContextualType(): Type<tsc.Type> | undefined;
    getDescendantAtPos(pos: number): Node<tsc.Node> | undefined;
    getDescendantAtStartWithWidth(
        start: number,
        width: number,
    ): Node<tsc.Node> | undefined;
    getDescendants(): Node<tsc.Node>[];
    getDescendantsOfKind<TKind extends tsc.SyntaxKind>(
        kind: TKind,
    ): KindToNodeMappings[TKind][];
    getDescendantStatements(): (
        Statement<tsc.Statement>
        | Expression<tsc.Expression>
    )[];
    getEnd(): number;
    getEndLineNumber(): number;
    getFirstAncestor<T extends Node<tsc.Node>>(
        condition?: (node: Node) => node is T,
    ): T | undefined;
    getFirstAncestor(
        condition?: (node: Node) => boolean,
    ): Node<tsc.Node> | undefined;
    getFirstAncestorByKind<TKind extends tsc.SyntaxKind>(
        kind: TKind,
    ): KindToNodeMappings[TKind] | undefined;
    getFirstAncestorByKindOrThrow<TKind extends tsc.SyntaxKind>(
        kind: TKind,
        message?: string | (() => string),
    ): KindToNodeMappings[TKind];
    getFirstAncestorOrThrow<T extends Node<tsc.Node>>(
        condition?: (node: Node) => node is T,
    ): T;
    getFirstAncestorOrThrow(condition?: (node: Node) => boolean): Node;
    getFirstChild<T extends Node<tsc.Node>>(
        condition?: (node: Node) => node is T,
    ): T | undefined;
    getFirstChild(
        condition?: (node: Node) => boolean,
    ): Node<tsc.Node> | undefined;
    getFirstChildByKind<TKind extends tsc.SyntaxKind>(
        kind: TKind,
    ): KindToNodeMappings[TKind] | undefined;
    getFirstChildByKindOrThrow<TKind extends tsc.SyntaxKind>(
        kind: TKind,
        message?: string | (() => string),
    ): KindToNodeMappings[TKind];
    getFirstChildIfKind<TKind extends tsc.SyntaxKind>(
        kind: TKind,
    ): KindToNodeMappings[TKind] | undefined;
    getFirstChildIfKindOrThrow<TKind extends tsc.SyntaxKind>(
        kind: TKind,
        message?: string | (() => string),
    ): KindToNodeMappings[TKind];
    getFirstChildOrThrow<T extends Node<tsc.Node>>(
        condition?: (node: Node) => node is T,
        message?: string | (() => string),
    ): T;
    getFirstChildOrThrow(
        condition?: (node: Node) => boolean,
        message?: string | (() => string),
    ): Node;
    getFirstDescendant<T extends Node<tsc.Node>>(
        condition?: (node: Node) => node is T,
    ): T | undefined;
    getFirstDescendant(
        condition?: (node: Node) => boolean,
    ): Node<tsc.Node> | undefined;
    getFirstDescendantByKind<TKind extends tsc.SyntaxKind>(
        kind: TKind,
    ): KindToNodeMappings[TKind] | undefined;
    getFirstDescendantByKindOrThrow<TKind extends tsc.SyntaxKind>(
        kind: TKind,
        message?: string | (() => string),
    ): KindToNodeMappings[TKind];
    getFirstDescendantOrThrow<T extends Node<tsc.Node>>(
        condition?: (node: Node) => node is T,
        message?: string | (() => string),
    ): T;
    getFirstDescendantOrThrow(
        condition?: (node: Node) => boolean,
        message?: string | (() => string),
    ): Node;
    getFlags(): tsc.NodeFlags;
    getFullStart(): number;
    getFullText(): string;
    getFullWidth(): number;
    getIndentationLevel(): number;
    getIndentationText(offset?: number): string;
    getKind(): tsc.SyntaxKind;
    getKindName(): string;
    getLastChild<T extends Node<tsc.Node>>(
        condition?: (node: Node) => node is T,
    ): T | undefined;
    getLastChild(
        condition?: (node: Node) => boolean,
    ): Node<tsc.Node> | undefined;
    getLastChildByKind<TKind extends tsc.SyntaxKind>(
        kind: TKind,
    ): KindToNodeMappings[TKind] | undefined;
    getLastChildByKindOrThrow<TKind extends tsc.SyntaxKind>(
        kind: TKind,
        message?: string | (() => string),
    ): KindToNodeMappings[TKind];
    getLastChildIfKind<TKind extends tsc.SyntaxKind>(
        kind: TKind,
    ): KindToNodeMappings[TKind] | undefined;
    getLastChildIfKindOrThrow<TKind extends tsc.SyntaxKind>(
        kind: TKind,
        message?: string | (() => string),
    ): KindToNodeMappings[TKind];
    getLastChildOrThrow<T extends Node<tsc.Node>>(
        condition?: (node: Node) => node is T,
        message?: string | (() => string),
    ): T;
    getLastChildOrThrow(
        condition?: (node: Node) => boolean,
        message?: string | (() => string),
    ): Node;
    getLastToken(): Node;
    getLeadingCommentRanges(): CommentRange[];
    getLeadingTriviaWidth(): number;
    getLeft(): Expression;
    getLocal(name: string): Symbol | undefined;
    getLocalOrThrow(name: string, message?: string | (() => string)): Symbol;
    getLocals(): Symbol[];
    getNextSibling<T extends Node<tsc.Node>>(
        condition?: (node: Node) => node is T,
    ): T | undefined;
    getNextSibling(
        condition?: (node: Node) => boolean,
    ): Node<tsc.Node> | undefined;
    getNextSiblingIfKind<TKind extends tsc.SyntaxKind>(
        kind: TKind,
    ): KindToNodeMappings[TKind] | undefined;
    getNextSiblingIfKindOrThrow<TKind extends tsc.SyntaxKind>(
        kind: TKind,
        message?: string | (() => string),
    ): KindToNodeMappings[TKind];
    getNextSiblingOrThrow<T extends Node<tsc.Node>>(
        condition?: (node: Node) => node is T,
        message?: string | (() => string),
    ): T;
    getNextSiblingOrThrow(
        condition?: (node: Node) => boolean,
        message?: string | (() => string),
    ): Node;
    getNextSiblings(): Node<tsc.Node>[];
    getNodeProperty<
        KeyType extends string
        | number
        | symbol,
        LocalNodeType extends tsc.Node = tsc.BinaryExpression,
    >(
        propertyName: KeyType,
    ): NodePropertyToWrappedType<LocalNodeType, KeyType>;
    getNonWhitespaceStart(): number;
    getOperatorToken(): Node<Token<InstanceOfKeyword>>;
    getParent(): Node<tsc.Node> | undefined;
    getParentIf<T extends Node<tsc.Node>>(
        condition: (
            parent: Node<tsc.Node> | undefined,
            node: Node,
        ) => parent is T,
    ): T | undefined;
    getParentIf(
        condition: (parent: Node<tsc.Node> | undefined, node: Node) => boolean,
    ): Node<tsc.Node> | undefined;
    getParentIfKind<TKind extends tsc.SyntaxKind>(
        kind: TKind,
    ): KindToNodeMappings[TKind] | undefined;
    getParentIfKindOrThrow<TKind extends tsc.SyntaxKind>(
        kind: TKind,
        message?: string | (() => string),
    ): KindToNodeMappings[TKind];
    getParentIfOrThrow<T extends Node<tsc.Node>>(
        condition: (
            parent: Node<tsc.Node> | undefined,
            node: Node,
        ) => parent is T,
        message?: string | (() => string),
    ): T;
    getParentIfOrThrow(
        condition: (parent: Node<tsc.Node> | undefined, node: Node) => boolean,
        message?: string | (() => string),
    ): Node;
    getParentOrThrow(message?: string | (() => string)): Node<tsc.Node>;
    getParentSyntaxList(): SyntaxList | undefined;
    getParentSyntaxListOrThrow(message?: string | (() => string)): SyntaxList;
    getParentWhile<T extends Node<tsc.Node>>(
        condition: (parent: Node, child: Node) => parent is T,
    ): T | undefined;
    getParentWhile(
        condition: (parent: Node, child: Node) => boolean,
    ): Node<tsc.Node> | undefined;
    getParentWhileKind<TKind extends tsc.SyntaxKind>(
        kind: TKind,
    ): KindToNodeMappings[TKind] | undefined;
    getParentWhileKindOrThrow<TKind extends tsc.SyntaxKind>(
        kind: TKind,
        message?: string | (() => string),
    ): KindToNodeMappings[TKind];
    getParentWhileOrThrow<T extends Node<tsc.Node>>(
        condition: (parent: Node, node: Node) => parent is T,
        message?: string | (() => string),
    ): T;
    getParentWhileOrThrow(
        condition: (parent: Node, node: Node) => boolean,
        message?: string | (() => string),
    ): Node;
    getPos(): number;
    getPreviousSibling<T extends Node<tsc.Node>>(
        condition?: (node: Node) => node is T,
    ): T | undefined;
    getPreviousSibling(
        condition?: (node: Node) => boolean,
    ): Node<tsc.Node> | undefined;
    getPreviousSiblingIfKind<TKind extends tsc.SyntaxKind>(
        kind: TKind,
    ): KindToNodeMappings[TKind] | undefined;
    getPreviousSiblingIfKindOrThrow<TKind extends tsc.SyntaxKind>(
        kind: TKind,
        message?: string | (() => string),
    ): KindToNodeMappings[TKind];
    getPreviousSiblingOrThrow<T extends Node<tsc.Node>>(
        condition?: (node: Node) => node is T,
        message?: string | (() => string),
    ): T;
    getPreviousSiblingOrThrow(
        condition?: (node: Node) => boolean,
        message?: string | (() => string),
    ): Node;
    getPreviousSiblings(): Node<tsc.Node>[];
    getProject(): Project;
    getRight(): Expression;
    getSourceFile(): SourceFile;
    getStart(includeJsDocComments?: boolean): number;
    getStartLineNumber(includeJsDocComments?: boolean): number;
    getStartLinePos(includeJsDocComments?: boolean): number;
    getSymbol(): Symbol | undefined;
    getSymbolOrThrow(message?: string | (() => string)): Symbol;
    getSymbolsInScope(meaning: tsc.SymbolFlags): Symbol[];
    getText(includeJsDocComments?: boolean): string;
    getText(
        options: {
            includeJsDocComments?: boolean;
            trimLeadingIndentation?: boolean;
        },
    ): string;
    getTrailingCommentRanges(): CommentRange[];
    getTrailingTriviaEnd(): number;
    getTrailingTriviaWidth(): number;
    getType(): Type;
    getWidth(includeJsDocComments?: boolean): number;
    isFirstNodeOnLine(): boolean;
    isInStringAtPos(pos: number): boolean;
    isInSyntaxList(): boolean;
    isKind<TKind extends tsc.SyntaxKind>(
        kind: TKind,
    ): this is KindToNodeMappings[TKind];
    prependWhitespace(textOrWriterFunction: string | WriterFunction): void;
    print(options?: PrintNodeOptions): string;
    replaceWithText(textOrWriterFunction: string | WriterFunction): Node;
    transform(
        visitNode: (traversal: TransformTraversalControl) => tsc.Node,
    ): Node;
    wasForgotten(): boolean;
}

Hierarchy (View Summary)

BinaryExpression
- InstanceofExpression

Index

Properties

compilerNode

Methods

appendWhitespace asKind asKindOrThrow containsRange forEachChild forEachChildAsArray forEachDescendant forEachDescendantAsArray forget forgetDescendants formatText getAncestors getChildAtIndex getChildAtIndexIfKind getChildAtIndexIfKindOrThrow getChildAtPos getChildCount getChildIndentationLevel getChildIndentationText getChildIndex getChildren getChildrenOfKind getChildSyntaxList getChildSyntaxListOrThrow getCombinedModifierFlags getContextualType getDescendantAtPos getDescendantAtStartWithWidth getDescendants getDescendantsOfKind getDescendantStatements getEnd getEndLineNumber getFirstAncestor getFirstAncestorByKind getFirstAncestorByKindOrThrow getFirstAncestorOrThrow getFirstChild getFirstChildByKind getFirstChildByKindOrThrow getFirstChildIfKind getFirstChildIfKindOrThrow getFirstChildOrThrow getFirstDescendant getFirstDescendantByKind getFirstDescendantByKindOrThrow getFirstDescendantOrThrow getFlags getFullStart getFullText getFullWidth getIndentationLevel getIndentationText getKind getKindName getLastChild getLastChildByKind getLastChildByKindOrThrow getLastChildIfKind getLastChildIfKindOrThrow getLastChildOrThrow getLastToken getLeadingCommentRanges getLeadingTriviaWidth getLeft getLocal getLocalOrThrow getLocals getNextSibling getNextSiblingIfKind getNextSiblingIfKindOrThrow getNextSiblingOrThrow getNextSiblings getNodeProperty getNonWhitespaceStart getOperatorToken getParent getParentIf getParentIfKind getParentIfKindOrThrow getParentIfOrThrow getParentOrThrow getParentSyntaxList getParentSyntaxListOrThrow getParentWhile getParentWhileKind getParentWhileKindOrThrow getParentWhileOrThrow getPos getPreviousSibling getPreviousSiblingIfKind getPreviousSiblingIfKindOrThrow getPreviousSiblingOrThrow getPreviousSiblings getProject getRight getSourceFile getStart getStartLineNumber getStartLinePos getSymbol getSymbolOrThrow getSymbolsInScope getText getTrailingCommentRanges getTrailingTriviaEnd getTrailingTriviaWidth getType getWidth isFirstNodeOnLine isInStringAtPos isInSyntaxList isKind prependWhitespace print replaceWithText transform wasForgotten

Properties

compilerNode

compilerNode: tsc.InstanceofExpression

Gets the underlying compiler node.

Methods

appendWhitespace

appendWhitespace(textOrWriterFunction: string | WriterFunction): void
Appends the specified whitespace to current node.
Parameters
- textOrWriterFunction: string | WriterFunction
  Text or writer function.
Returns void
Inherited from BinaryExpression.appendWhitespace
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3847

asKind

asKind<TKind extends tsc.SyntaxKind>(
kind: TKind,
): KindToNodeMappings[TKind] | undefined
Gets the node as the specified kind if it is equal to that kind, otherwise returns undefined.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind.
Returns KindToNodeMappings[TKind] | undefined
Inherited from BinaryExpression.asKind
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3524

asKindOrThrow

asKindOrThrow<TKind extends tsc.SyntaxKind>(
kind: TKind,
message?: string | (() => string),
): KindToNodeMappings[TKind]
Gets the node as the specified kind if it is equal to that kind, otherwise throws.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind.
- Optionalmessage: string | (() => string)
Returns KindToNodeMappings[TKind]
Inherited from BinaryExpression.asKindOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3512

containsRange

containsRange(pos: number, end: number): boolean
If the node contains the provided range (inclusive).
Parameters
- pos: number
  Start position.
- end: number
  End position.
Returns boolean
Inherited from BinaryExpression.containsRange
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3502

forEachChild

forEachChild<T>(
cbNode: (node: Node) => T | undefined,
cbNodeArray?: (nodes: Node<tsc.Node>[]) => T | undefined,
): T | undefined
Invokes the cbNode callback for each child and the cbNodeArray for every array of nodes stored in properties of the node. If cbNodeArray is not defined, then it will pass every element of the array to cbNode.
Type Parameters
- T
Parameters
- cbNode: (node: Node) => T | undefined
  Callback invoked for each child.
- OptionalcbNodeArray: (nodes: Node<tsc.Node>[]) => T | undefined
  Callback invoked for each array of nodes.
Returns T | undefined
The first truthy value returned by a callback.
Inherited from BinaryExpression.forEachChild
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3655

forEachChildAsArray

forEachChildAsArray(): Node<tsc.Node>[]
Gets the child nodes passed to the delegate of node.forEachChild(child => {}) as an array.

Returns Node<tsc.Node>[]
Inherited from BinaryExpression.forEachChildAsArray
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3667

forEachDescendant

forEachDescendant<T>(
    cbNode: (
        node: Node,
        traversal: ForEachDescendantTraversalControl,
    ) => T | undefined,
    cbNodeArray?: (
        nodes: Node<tsc.Node>[],
        traversal: ForEachDescendantTraversalControl,
    ) => T | undefined,
): T | undefined
Invokes the cbNode callback for each descendant and the cbNodeArray for every array of nodes stored in properties of the node and descendant nodes. If cbNodeArray is not defined, then it will pass every element of the array to cbNode.
Type Parameters
- T
Parameters
- cbNode: (node: Node, traversal: ForEachDescendantTraversalControl) => T | undefined
  Callback invoked for each descendant.
- OptionalcbNodeArray: (
  nodes: Node<tsc.Node>[],
  traversal: ForEachDescendantTraversalControl,
  ) => T | undefined
  Callback invoked for each array of nodes.
Returns T | undefined
The first truthy value returned by a callback.

Remarks
There exists a traversal object on the second parameter that allows various control of iteration.
Inherited from BinaryExpression.forEachDescendant
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3665

forEachDescendantAsArray

forEachDescendantAsArray(): Node<tsc.Node>[]
Gets the descendant nodes passed to the delegate of node.forEachDescendant(descendant => {}) as an array.

Returns Node<tsc.Node>[]
Inherited from BinaryExpression.forEachDescendantAsArray
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3669

forget

forget(): void
Releases the node and all its descendants from the underlying node cache and ast.

This is useful if you want to improve the performance of manipulation by not tracking this node anymore.

Returns void
Inherited from BinaryExpression.forget
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3443

forgetDescendants

forgetDescendants(): void
Forgets the descendants of this node.

Returns void
Inherited from BinaryExpression.forgetDescendants
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3445

formatText

formatText(settings?: FormatCodeSettings): void
Formats the node's text using the internal TypeScript formatting API.
Parameters
- Optionalsettings: FormatCodeSettings
  Format code settings.
Returns void
Inherited from BinaryExpression.formatText
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3852

getAncestors

getAncestors(): Node<tsc.Node>[]
Goes up the tree getting all the parents in ascending order.

Returns Node<tsc.Node>[]
Inherited from BinaryExpression.getAncestors
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3749

getChildAtIndex

getChildAtIndex(index: number): Node
Gets the child at the specified index.
Parameters
- index: number
  Index of the child.
Returns Node
Inherited from BinaryExpression.getChildAtIndex
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3643

getChildAtIndexIfKind

getChildAtIndexIfKind<TKind extends tsc.SyntaxKind>(
index: number,
kind: TKind,
): KindToNodeMappings[TKind] | undefined
Gets the child at the specified index if it's the specified kind or returns undefined.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- index: number
  Child index to get.
- kind: TKind
  Expected kind.
Returns KindToNodeMappings[TKind] | undefined
Inherited from BinaryExpression.getChildAtIndexIfKind
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3937

getChildAtIndexIfKindOrThrow

getChildAtIndexIfKindOrThrow<TKind extends tsc.SyntaxKind>(
    index: number,
    kind: TKind,
    message?: string | (() => string),
): KindToNodeMappings[TKind]
Gets the child at the specified index if it's the specified kind or throws an exception.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- index: number
  Child index to get.
- kind: TKind
  Expected kind.
- Optionalmessage: string | (() => string)
Returns KindToNodeMappings[TKind]
Inherited from BinaryExpression.getChildAtIndexIfKindOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3931

getChildAtPos

getChildAtPos(pos: number): Node<tsc.Node> | undefined
Gets the child at the provided text position, or undefined if not found.
Parameters
- pos: number
  Text position to search for.
Returns Node<tsc.Node> | undefined
Inherited from BinaryExpression.getChildAtPos
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3680

getChildCount

getChildCount(): number
Gets the number of children the node has.

Returns number
Inherited from BinaryExpression.getChildCount
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3675

getChildIndentationLevel

getChildIndentationLevel(): number
Gets the child indentation level of the current node.

Returns number
Inherited from BinaryExpression.getChildIndentationLevel
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3803

getChildIndentationText

getChildIndentationText(offset?: number): string
Gets the next indentation level text.
Parameters
- Optionaloffset: number
  Optional number of levels of indentation to add or remove.
Returns string
Inherited from BinaryExpression.getChildIndentationText
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3813

getChildIndex

getChildIndex(): number
Gets the child index of this node relative to the parent.

Returns number
Inherited from BinaryExpression.getChildIndex
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3799

getChildren

getChildren(): Node<tsc.Node>[]
Gets all the children of the node.

Returns Node<tsc.Node>[]
Inherited from BinaryExpression.getChildren
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3638

getChildrenOfKind

getChildrenOfKind<TKind extends tsc.SyntaxKind>(
kind: TKind,
): KindToNodeMappings[TKind][]
Gets the children based on a kind.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind.
Returns KindToNodeMappings[TKind][]
Inherited from BinaryExpression.getChildrenOfKind
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3885

getChildSyntaxList

getChildSyntaxList(): SyntaxList | undefined
Gets the child syntax list if it exists.

Returns SyntaxList | undefined
Inherited from BinaryExpression.getChildSyntaxList
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3647

getChildSyntaxListOrThrow

getChildSyntaxListOrThrow(message?: string | (() => string)): SyntaxList
Gets the child syntax list or throws if it doesn't exist.
Parameters
- Optionalmessage: string | (() => string)
Returns SyntaxList
Inherited from BinaryExpression.getChildSyntaxListOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3645

getCombinedModifierFlags

getCombinedModifierFlags(): ModifierFlags
Gets the combined modifier flags.

Returns ModifierFlags
Inherited from BinaryExpression.getCombinedModifierFlags
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3738

getContextualType

getContextualType(): Type<tsc.Type> | undefined
Gets the contextual type of the expression.

Returns Type<tsc.Type> | undefined
Inherited from BinaryExpression.getContextualType
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:5270

getDescendantAtPos

getDescendantAtPos(pos: number): Node<tsc.Node> | undefined
Gets the most specific descendant at the provided text position, or undefined if not found.
Parameters
- pos: number
  Text position to search for.
Returns Node<tsc.Node> | undefined
Inherited from BinaryExpression.getDescendantAtPos
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3685

getDescendantAtStartWithWidth

getDescendantAtStartWithWidth(
start: number,
width: number,
): Node<tsc.Node> | undefined
Gets the most specific descendant at the provided start text position with the specified width, or undefined if not found.
Parameters
- start: number
  Start text position to search for.
- width: number
  Text length of the node to search for.
Returns Node<tsc.Node> | undefined
Inherited from BinaryExpression.getDescendantAtStartWithWidth
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3691

getDescendants

getDescendants(): Node<tsc.Node>[]
Gets the node's descendants.

Returns Node<tsc.Node>[]
Inherited from BinaryExpression.getDescendants
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3671

getDescendantsOfKind

getDescendantsOfKind<TKind extends tsc.SyntaxKind>(
kind: TKind,
): KindToNodeMappings[TKind][]
Gets the descendants that match a specified syntax kind.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Kind to check.
Returns KindToNodeMappings[TKind][]
Inherited from BinaryExpression.getDescendantsOfKind
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:4004

getDescendantStatements

getDescendantStatements(): (
Statement<tsc.Statement>
| Expression<tsc.Expression>
)[]
Gets the node's descendant statements and any arrow function statement-like expressions (ex. returns the expression 5 in () => 5).

Returns (Statement<tsc.Statement> | Expression<tsc.Expression>)[]
Inherited from BinaryExpression.getDescendantStatements
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3673

getEnd

getEnd(): number
Gets the source file text position where the node ends.

Returns number
Remarks
This does not include the following trivia (comments and whitespace).
Inherited from BinaryExpression.getEnd
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3699

getEndLineNumber

getEndLineNumber(): number
Gets the line number of the end of the node.

Returns number
Inherited from BinaryExpression.getEndLineNumber
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3825

getFirstAncestor

getFirstAncestor<T extends Node<tsc.Node>>(
condition?: (node: Node) => node is T,
): T | undefined
Gets the first ancestor that matches the provided condition or returns undefined if not found.
Type Parameters
- T extends Node<tsc.Node>
Parameters
- Optionalcondition: (node: Node) => node is T
  Condition to match.
Returns T | undefined
Inherited from BinaryExpression.getFirstAncestor
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3994
getFirstAncestor(
condition?: (node: Node) => boolean,
): Node<tsc.Node> | undefined
Gets the first ancestor that matches the provided condition or returns undefined if not found.
Parameters
- Optionalcondition: (node: Node) => boolean
  Condition to match.
Returns Node<tsc.Node> | undefined
Inherited from BinaryExpression.getFirstAncestor
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3999

getFirstAncestorByKind

getFirstAncestorByKind<TKind extends tsc.SyntaxKind>(
kind: TKind,
): KindToNodeMappings[TKind] | undefined
Get the first ancestor by syntax kind.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind.
Returns KindToNodeMappings[TKind] | undefined
Inherited from BinaryExpression.getFirstAncestorByKind
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3979

getFirstAncestorByKindOrThrow

getFirstAncestorByKindOrThrow<TKind extends tsc.SyntaxKind>(
kind: TKind,
message?: string | (() => string),
): KindToNodeMappings[TKind]
Gets the first ancestor by syntax kind or throws if not found.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind.
- Optionalmessage: string | (() => string)
Returns KindToNodeMappings[TKind]
Inherited from BinaryExpression.getFirstAncestorByKindOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3974

getFirstAncestorOrThrow

getFirstAncestorOrThrow<T extends Node<tsc.Node>>(
condition?: (node: Node) => node is T,
): T
Gets the first ancestor that matches the provided condition or throws if not found.
Type Parameters
- T extends Node<tsc.Node>
Parameters
- Optionalcondition: (node: Node) => node is T
  Condition to match.
Returns T
Inherited from BinaryExpression.getFirstAncestorOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3984
getFirstAncestorOrThrow(condition?: (node: Node) => boolean): Node
Gets the first ancestor that matches the provided condition or throws if not found.
Parameters
- Optionalcondition: (node: Node) => boolean
  Condition to match.
Returns Node
Inherited from BinaryExpression.getFirstAncestorOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3989

getFirstChild

getFirstChild<T extends Node<tsc.Node>>(
condition?: (node: Node) => node is T,
): T | undefined
Gets the first child by a condition.
Type Parameters
- T extends Node<tsc.Node>
Parameters
- Optionalcondition: (node: Node) => node is T
  Condition.
Returns T | undefined
Inherited from BinaryExpression.getFirstChild
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3539
getFirstChild(condition?: (node: Node) => boolean): Node<tsc.Node> | undefined
Gets the first child by a condition.
Parameters
- Optionalcondition: (node: Node) => boolean
  Condition.
Returns Node<tsc.Node> | undefined
Inherited from BinaryExpression.getFirstChild
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3544

getFirstChildByKind

getFirstChildByKind<TKind extends tsc.SyntaxKind>(
kind: TKind,
): KindToNodeMappings[TKind] | undefined
Gets the first child by syntax kind.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind.
Returns KindToNodeMappings[TKind] | undefined
Inherited from BinaryExpression.getFirstChildByKind
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3895

getFirstChildByKindOrThrow

getFirstChildByKindOrThrow<TKind extends tsc.SyntaxKind>(
kind: TKind,
message?: string | (() => string),
): KindToNodeMappings[TKind]
Gets the first child by syntax kind or throws an error if not found.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind.
- Optionalmessage: string | (() => string)
Returns KindToNodeMappings[TKind]
Inherited from BinaryExpression.getFirstChildByKindOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3890

getFirstChildIfKind

getFirstChildIfKind<TKind extends tsc.SyntaxKind>(
kind: TKind,
): KindToNodeMappings[TKind] | undefined
Gets the first child if it matches the specified syntax kind.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind.
Returns KindToNodeMappings[TKind] | undefined
Inherited from BinaryExpression.getFirstChildIfKind
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3905

getFirstChildIfKindOrThrow

getFirstChildIfKindOrThrow<TKind extends tsc.SyntaxKind>(
kind: TKind,
message?: string | (() => string),
): KindToNodeMappings[TKind]
Gets the first child if it matches the specified syntax kind or throws an error if not found.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind.
- Optionalmessage: string | (() => string)
Returns KindToNodeMappings[TKind]
Inherited from BinaryExpression.getFirstChildIfKindOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3900

getFirstChildOrThrow

getFirstChildOrThrow<T extends Node<tsc.Node>>(
condition?: (node: Node) => node is T,
message?: string | (() => string),
): T
Gets the first child by a condition or throws.
Type Parameters
- T extends Node<tsc.Node>
Parameters
- Optionalcondition: (node: Node) => node is T
  Condition.
- Optionalmessage: string | (() => string)
Returns T
Inherited from BinaryExpression.getFirstChildOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3529
getFirstChildOrThrow(
condition?: (node: Node) => boolean,
message?: string | (() => string),
): Node
Gets the first child by a condition or throws.
Parameters
- Optionalcondition: (node: Node) => boolean
  Condition.
- Optionalmessage: string | (() => string)
Returns Node
Inherited from BinaryExpression.getFirstChildOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3534

getFirstDescendant

getFirstDescendant<T extends Node<tsc.Node>>(
condition?: (node: Node) => node is T,
): T | undefined
Gets the first descendant by a condition.
Type Parameters
- T extends Node<tsc.Node>
Parameters
- Optionalcondition: (node: Node) => node is T
  Condition.
Returns T | undefined
Inherited from BinaryExpression.getFirstDescendant
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3579
getFirstDescendant(
condition?: (node: Node) => boolean,
): Node<tsc.Node> | undefined
Gets the first descendant by a condition.
Parameters
- Optionalcondition: (node: Node) => boolean
  Condition.
Returns Node<tsc.Node> | undefined
Inherited from BinaryExpression.getFirstDescendant
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3584

getFirstDescendantByKind

getFirstDescendantByKind<TKind extends tsc.SyntaxKind>(
kind: TKind,
): KindToNodeMappings[TKind] | undefined
Gets the first descendant by syntax kind.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind.
Returns KindToNodeMappings[TKind] | undefined
Inherited from BinaryExpression.getFirstDescendantByKind
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:4014

getFirstDescendantByKindOrThrow

getFirstDescendantByKindOrThrow<TKind extends tsc.SyntaxKind>(
kind: TKind,
message?: string | (() => string),
): KindToNodeMappings[TKind]
Gets the first descendant by syntax kind or throws.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind.
- Optionalmessage: string | (() => string)
Returns KindToNodeMappings[TKind]
Inherited from BinaryExpression.getFirstDescendantByKindOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:4009

getFirstDescendantOrThrow

getFirstDescendantOrThrow<T extends Node<tsc.Node>>(
condition?: (node: Node) => node is T,
message?: string | (() => string),
): T
Gets the first descendant by a condition or throws.
Type Parameters
- T extends Node<tsc.Node>
Parameters
- Optionalcondition: (node: Node) => node is T
  Condition.
- Optionalmessage: string | (() => string)
Returns T
Inherited from BinaryExpression.getFirstDescendantOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3569
getFirstDescendantOrThrow(
condition?: (node: Node) => boolean,
message?: string | (() => string),
): Node
Gets the first descendant by a condition or throws.
Parameters
- Optionalcondition: (node: Node) => boolean
  Condition.
- Optionalmessage: string | (() => string)
Returns Node
Inherited from BinaryExpression.getFirstDescendantOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3574

getFlags

getFlags(): tsc.NodeFlags
Gets the node's flags.

Returns tsc.NodeFlags
Inherited from BinaryExpression.getFlags
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3457

getFullStart

getFullStart(): number
Gets the source file text position of the end of the last significant token or the start of the source file.

Returns number
Inherited from BinaryExpression.getFullStart
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3706

getFullText

getFullText(): string
Gets the full text with leading trivia (comments and whitespace).

Returns string
Inherited from BinaryExpression.getFullText
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3736

getFullWidth

getFullWidth(): number
Gets the text length of the node with trivia.

Returns number
Inherited from BinaryExpression.getFullWidth
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3715

getIndentationLevel

getIndentationLevel(): number
Gets the indentation level of the current node.

Returns number
Inherited from BinaryExpression.getIndentationLevel
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3801

getIndentationText

getIndentationText(offset?: number): string
Gets the indentation text.
Parameters
- Optionaloffset: number
  Optional number of levels of indentation to add or remove.
Returns string
Inherited from BinaryExpression.getIndentationText
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3808

getKind

getKind(): tsc.SyntaxKind
Gets the syntax kind.

Returns tsc.SyntaxKind
Inherited from BinaryExpression.getKind
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3453

getKindName

getKindName(): string
Gets the syntax kind name.

Returns string
Inherited from BinaryExpression.getKindName
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3455

getLastChild

getLastChild<T extends Node<tsc.Node>>(
condition?: (node: Node) => node is T,
): T | undefined
Gets the last child by a condition.
Type Parameters
- T extends Node<tsc.Node>
Parameters
- Optionalcondition: (node: Node) => node is T
  Condition.
Returns T | undefined
Inherited from BinaryExpression.getLastChild
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3559
getLastChild(condition?: (node: Node) => boolean): Node<tsc.Node> | undefined
Gets the last child by a condition.
Parameters
- Optionalcondition: (node: Node) => boolean
  Condition.
Returns Node<tsc.Node> | undefined
Inherited from BinaryExpression.getLastChild
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3564

getLastChildByKind

getLastChildByKind<TKind extends tsc.SyntaxKind>(
kind: TKind,
): KindToNodeMappings[TKind] | undefined
Gets the last child by syntax kind.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind.
Returns KindToNodeMappings[TKind] | undefined
Inherited from BinaryExpression.getLastChildByKind
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3915

getLastChildByKindOrThrow

getLastChildByKindOrThrow<TKind extends tsc.SyntaxKind>(
kind: TKind,
message?: string | (() => string),
): KindToNodeMappings[TKind]
Gets the last child by syntax kind or throws an error if not found.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind.
- Optionalmessage: string | (() => string)
Returns KindToNodeMappings[TKind]
Inherited from BinaryExpression.getLastChildByKindOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3910

getLastChildIfKind

getLastChildIfKind<TKind extends tsc.SyntaxKind>(
kind: TKind,
): KindToNodeMappings[TKind] | undefined
Gets the last child if it matches the specified syntax kind.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind.
Returns KindToNodeMappings[TKind] | undefined
Inherited from BinaryExpression.getLastChildIfKind
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3925

getLastChildIfKindOrThrow

getLastChildIfKindOrThrow<TKind extends tsc.SyntaxKind>(
kind: TKind,
message?: string | (() => string),
): KindToNodeMappings[TKind]
Gets the last child if it matches the specified syntax kind or throws an error if not found.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind.
- Optionalmessage: string | (() => string)
Returns KindToNodeMappings[TKind]
Inherited from BinaryExpression.getLastChildIfKindOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3920

getLastChildOrThrow

getLastChildOrThrow<T extends Node<tsc.Node>>(
condition?: (node: Node) => node is T,
message?: string | (() => string),
): T
Gets the last child by a condition or throws.
Type Parameters
- T extends Node<tsc.Node>
Parameters
- Optionalcondition: (node: Node) => node is T
  Condition.
- Optionalmessage: string | (() => string)
Returns T
Inherited from BinaryExpression.getLastChildOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3549
getLastChildOrThrow(
condition?: (node: Node) => boolean,
message?: string | (() => string),
): Node
Gets the last child by a condition or throws.
Parameters
- Optionalcondition: (node: Node) => boolean
  Condition.
- Optionalmessage: string | (() => string)
Returns Node
Inherited from BinaryExpression.getLastChildOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3554

getLastToken

getLastToken(): Node
Gets the last token of this node. Usually this is a close brace.

Returns Node
Inherited from BinaryExpression.getLastToken
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3791

getLeadingCommentRanges

getLeadingCommentRanges(): CommentRange[]
Gets the leading comment ranges of the current node.

Returns CommentRange[]
Inherited from BinaryExpression.getLeadingCommentRanges
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3878

getLeadingTriviaWidth

getLeadingTriviaWidth(): number
Gets the node's leading trivia's text length.

Returns number
Inherited from BinaryExpression.getLeadingTriviaWidth
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3717

getLeft

getLeft(): Expression
Gets the left side of the binary expression.

Returns Expression
Inherited from BinaryExpression.getLeft
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:5206

getLocal

getLocal(name: string): Symbol | undefined
Gets the specified local symbol by name or returns undefined if it doesn't exist.

WARNING: The symbol table of locals is not exposed publicly by the compiler. Use this at your own risk knowing it may break.
Parameters
- name: string
  Name of the local symbol.
Returns Symbol | undefined
Inherited from BinaryExpression.getLocal
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3488

getLocalOrThrow

getLocalOrThrow(name: string, message?: string | (() => string)): Symbol
Gets the specified local symbol by name or throws if it doesn't exist.

WARNING: The symbol table of locals is not exposed publicly by the compiler. Use this at your own risk knowing it may break.
Parameters
- name: string
  Name of the local symbol.
- Optionalmessage: string | (() => string)
Returns Symbol
Inherited from BinaryExpression.getLocalOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3481

getLocals

getLocals(): Symbol[]
Gets the symbols within the current scope.

WARNING: The symbol table of locals is not exposed publicly by the compiler. Use this at your own risk knowing it may break.

Returns Symbol[]
Inherited from BinaryExpression.getLocals
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3494

getNextSibling

getNextSibling<T extends Node<tsc.Node>>(
condition?: (node: Node) => node is T,
): T | undefined
Gets the next sibling.
Type Parameters
- T extends Node<tsc.Node>
Parameters
- Optionalcondition: (node: Node) => node is T
  Optional condition for getting the next sibling.
Returns T | undefined
Inherited from BinaryExpression.getNextSibling
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3619
getNextSibling(condition?: (node: Node) => boolean): Node<tsc.Node> | undefined
Gets the next sibling.
Parameters
- Optionalcondition: (node: Node) => boolean
  Optional condition for getting the next sibling.
Returns Node<tsc.Node> | undefined
Inherited from BinaryExpression.getNextSibling
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3624

getNextSiblingIfKind

getNextSiblingIfKind<TKind extends tsc.SyntaxKind>(
kind: TKind,
): KindToNodeMappings[TKind] | undefined
Gets the next sibling if it matches the specified kind.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Kind to check.
Returns KindToNodeMappings[TKind] | undefined
Inherited from BinaryExpression.getNextSiblingIfKind
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3957

getNextSiblingIfKindOrThrow

getNextSiblingIfKindOrThrow<TKind extends tsc.SyntaxKind>(
kind: TKind,
message?: string | (() => string),
): KindToNodeMappings[TKind]
Gets the next sibiling if it matches the specified kind, or throws.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Kind to check.
- Optionalmessage: string | (() => string)
Returns KindToNodeMappings[TKind]
Inherited from BinaryExpression.getNextSiblingIfKindOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3947

getNextSiblingOrThrow

getNextSiblingOrThrow<T extends Node<tsc.Node>>(
condition?: (node: Node) => node is T,
message?: string | (() => string),
): T
Gets the next sibling or throws.
Type Parameters
- T extends Node<tsc.Node>
Parameters
- Optionalcondition: (node: Node) => node is T
  Optional condition for getting the next sibling.
- Optionalmessage: string | (() => string)
Returns T
Inherited from BinaryExpression.getNextSiblingOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3609
getNextSiblingOrThrow(
condition?: (node: Node) => boolean,
message?: string | (() => string),
): Node
Gets the next sibling or throws.
Parameters
- Optionalcondition: (node: Node) => boolean
  Optional condition for getting the next sibling.
- Optionalmessage: string | (() => string)
Returns Node
Inherited from BinaryExpression.getNextSiblingOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3614

getNextSiblings

getNextSiblings(): Node<tsc.Node>[]
Gets the next siblings.

Note: Closest sibling is the zero index.

Returns Node<tsc.Node>[]
Inherited from BinaryExpression.getNextSiblings
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3636

getNodeProperty

getNodeProperty<
    KeyType extends string
    | number
    | symbol,
    LocalNodeType extends tsc.Node = tsc.BinaryExpression,
>(
    propertyName: KeyType,
): NodePropertyToWrappedType<LocalNodeType, KeyType>
Gets a compiler node property wrapped in a Node.
Type Parameters
- KeyType extends string | number | symbol
- LocalNodeType extends tsc.Node = tsc.BinaryExpression
Parameters
- propertyName: KeyType
  Property name.
Returns NodePropertyToWrappedType<LocalNodeType, KeyType>
Inherited from BinaryExpression.getNodeProperty
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3747

getNonWhitespaceStart

getNonWhitespaceStart(): number
Gets the first source file text position that is not whitespace taking into account comment nodes and a previous node's trailing trivia.

Returns number
Inherited from BinaryExpression.getNonWhitespaceStart
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3708

getOperatorToken

getOperatorToken(): Node<Token<InstanceOfKeyword>>
Gets the operator token of the binary expression.

Returns Node<Token<InstanceOfKeyword>>
Overrides BinaryExpression.getOperatorToken
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:5199

getParent

getParent(): Node<tsc.Node> | undefined
Get the node's parent.

Returns Node<tsc.Node> | undefined
Inherited from BinaryExpression.getParent
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3751

getParentIf

getParentIf<T extends Node<tsc.Node>>(
    condition: (
        parent: Node<tsc.Node> | undefined,
        node: Node,
    ) => parent is T,
): T | undefined
Gets the parent if it matches a certain condition.
Type Parameters
- T extends Node<tsc.Node>
Parameters
- condition: (parent: Node<tsc.Node> | undefined, node: Node) => parent is T
Returns T | undefined
Inherited from BinaryExpression.getParentIf
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3963
getParentIf(
condition: (parent: Node<tsc.Node> | undefined, node: Node) => boolean,
): Node<tsc.Node> | undefined
Gets the parent if it matches a certain condition.
Parameters
- condition: (parent: Node<tsc.Node> | undefined, node: Node) => boolean
Returns Node<tsc.Node> | undefined
Inherited from BinaryExpression.getParentIf
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3965

getParentIfKind

getParentIfKind<TKind extends tsc.SyntaxKind>(
kind: TKind,
): KindToNodeMappings[TKind] | undefined
Gets the parent if it's a certain syntax kind.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
Returns KindToNodeMappings[TKind] | undefined
Inherited from BinaryExpression.getParentIfKind
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3969

getParentIfKindOrThrow

getParentIfKindOrThrow<TKind extends tsc.SyntaxKind>(
kind: TKind,
message?: string | (() => string),
): KindToNodeMappings[TKind]
Gets the parent if it's a certain syntax kind or throws.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
- Optionalmessage: string | (() => string)
Returns KindToNodeMappings[TKind]
Inherited from BinaryExpression.getParentIfKindOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3967

getParentIfOrThrow

getParentIfOrThrow<T extends Node<tsc.Node>>(
    condition: (
        parent: Node<tsc.Node> | undefined,
        node: Node,
    ) => parent is T,
    message?: string | (() => string),
): T
Gets the parent if it matches a certain condition or throws.
Type Parameters
- T extends Node<tsc.Node>
Parameters
- condition: (parent: Node<tsc.Node> | undefined, node: Node) => parent is T
- Optionalmessage: string | (() => string)
Returns T
Inherited from BinaryExpression.getParentIfOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3959
getParentIfOrThrow(
condition: (parent: Node<tsc.Node> | undefined, node: Node) => boolean,
message?: string | (() => string),
): Node
Gets the parent if it matches a certain condition or throws.
Parameters
- condition: (parent: Node<tsc.Node> | undefined, node: Node) => boolean
- Optionalmessage: string | (() => string)
Returns Node
Inherited from BinaryExpression.getParentIfOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3961

getParentOrThrow

getParentOrThrow(message?: string | (() => string)): Node<tsc.Node>
Gets the parent or throws an error if it doesn't exist.
Parameters
- Optionalmessage: string | (() => string)
Returns Node<tsc.Node>
Inherited from BinaryExpression.getParentOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3753

getParentSyntaxList

getParentSyntaxList(): SyntaxList | undefined
Gets the parent if it's a syntax list.

Returns SyntaxList | undefined
Inherited from BinaryExpression.getParentSyntaxList
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3797

getParentSyntaxListOrThrow

getParentSyntaxListOrThrow(message?: string | (() => string)): SyntaxList
Gets the parent if it's a syntax list or throws an error otherwise.
Parameters
- Optionalmessage: string | (() => string)
Returns SyntaxList
Inherited from BinaryExpression.getParentSyntaxListOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3795

getParentWhile

getParentWhile<T extends Node<tsc.Node>>(
condition: (parent: Node, child: Node) => parent is T,
): T | undefined
Goes up the parents (ancestors) of the node while a condition is true. Returns undefined if the initial parent doesn't match the condition.
Type Parameters
- T extends Node<tsc.Node>
Parameters
- condition: (parent: Node, child: Node) => parent is T
  Condition that tests the parent to see if the expression is true.
Returns T | undefined
Inherited from BinaryExpression.getParentWhile
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3771
getParentWhile(
condition: (parent: Node, child: Node) => boolean,
): Node<tsc.Node> | undefined
Goes up the parents (ancestors) of the node while a condition is true. Returns undefined if the initial parent doesn't match the condition.
Parameters
- condition: (parent: Node, child: Node) => boolean
  Condition that tests the parent to see if the expression is true.
Returns Node<tsc.Node> | undefined
Inherited from BinaryExpression.getParentWhile
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3777

getParentWhileKind

getParentWhileKind<TKind extends tsc.SyntaxKind>(
kind: TKind,
): KindToNodeMappings[TKind] | undefined
Goes up the parents (ancestors) of the node while the parent is the specified syntax kind. Returns undefined if the initial parent is not the specified syntax kind.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind to check for.
Returns KindToNodeMappings[TKind] | undefined
Inherited from BinaryExpression.getParentWhileKind
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3789

getParentWhileKindOrThrow

getParentWhileKindOrThrow<TKind extends tsc.SyntaxKind>(
kind: TKind,
message?: string | (() => string),
): KindToNodeMappings[TKind]
Goes up the parents (ancestors) of the node while the parent is the specified syntax kind. Throws if the initial parent is not the specified syntax kind.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind to check for.
- Optionalmessage: string | (() => string)
Returns KindToNodeMappings[TKind]
Inherited from BinaryExpression.getParentWhileKindOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3783

getParentWhileOrThrow

getParentWhileOrThrow<T extends Node<tsc.Node>>(
condition: (parent: Node, node: Node) => parent is T,
message?: string | (() => string),
): T
Goes up the parents (ancestors) of the node while a condition is true. Throws if the initial parent doesn't match the condition.
Type Parameters
- T extends Node<tsc.Node>
Parameters
- condition: (parent: Node, node: Node) => parent is T
  Condition that tests the parent to see if the expression is true.
- Optionalmessage: string | (() => string)
Returns T
Inherited from BinaryExpression.getParentWhileOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3759
getParentWhileOrThrow(
condition: (parent: Node, node: Node) => boolean,
message?: string | (() => string),
): Node
Goes up the parents (ancestors) of the node while a condition is true. Throws if the initial parent doesn't match the condition.
Parameters
- condition: (parent: Node, node: Node) => boolean
  Condition that tests the parent to see if the expression is true.
- Optionalmessage: string | (() => string)
Returns Node
Inherited from BinaryExpression.getParentWhileOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3765

getPos

getPos(): number
Gets the source file text position where the node starts that includes the leading trivia (comments and whitespace).

Returns number
Inherited from BinaryExpression.getPos
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3693

getPreviousSibling

getPreviousSibling<T extends Node<tsc.Node>>(
condition?: (node: Node) => node is T,
): T | undefined
Gets the previous sibling.
Type Parameters
- T extends Node<tsc.Node>
Parameters
- Optionalcondition: (node: Node) => node is T
  Optional condition for getting the previous sibling.
Returns T | undefined
Inherited from BinaryExpression.getPreviousSibling
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3599
getPreviousSibling(
condition?: (node: Node) => boolean,
): Node<tsc.Node> | undefined
Gets the previous sibling.
Parameters
- Optionalcondition: (node: Node) => boolean
  Optional condition for getting the previous sibling.
Returns Node<tsc.Node> | undefined
Inherited from BinaryExpression.getPreviousSibling
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3604

getPreviousSiblingIfKind

getPreviousSiblingIfKind<TKind extends tsc.SyntaxKind>(
kind: TKind,
): KindToNodeMappings[TKind] | undefined
Gets the previous sibling if it matches the specified kind.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Kind to check.
Returns KindToNodeMappings[TKind] | undefined
Inherited from BinaryExpression.getPreviousSiblingIfKind
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3952

getPreviousSiblingIfKindOrThrow

getPreviousSiblingIfKindOrThrow<TKind extends tsc.SyntaxKind>(
kind: TKind,
message?: string | (() => string),
): KindToNodeMappings[TKind]
Gets the previous sibiling if it matches the specified kind, or throws.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Kind to check.
- Optionalmessage: string | (() => string)
Returns KindToNodeMappings[TKind]
Inherited from BinaryExpression.getPreviousSiblingIfKindOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3942

getPreviousSiblingOrThrow

getPreviousSiblingOrThrow<T extends Node<tsc.Node>>(
condition?: (node: Node) => node is T,
message?: string | (() => string),
): T
Gets the previous sibling or throws.
Type Parameters
- T extends Node<tsc.Node>
Parameters
- Optionalcondition: (node: Node) => node is T
  Optional condition for getting the previous sibling.
- Optionalmessage: string | (() => string)
Returns T
Inherited from BinaryExpression.getPreviousSiblingOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3589
getPreviousSiblingOrThrow(
condition?: (node: Node) => boolean,
message?: string | (() => string),
): Node
Gets the previous sibling or throws.
Parameters
- Optionalcondition: (node: Node) => boolean
  Optional condition for getting the previous sibling.
- Optionalmessage: string | (() => string)
Returns Node
Inherited from BinaryExpression.getPreviousSiblingOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3594

getPreviousSiblings

getPreviousSiblings(): Node<tsc.Node>[]
Gets the previous siblings.

Note: Closest sibling is the zero index.

Returns Node<tsc.Node>[]
Inherited from BinaryExpression.getPreviousSiblings
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3630

getProject

getProject(): Project
Gets the project.

Returns Project
Inherited from BinaryExpression.getProject
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3742

getRight

getRight(): Expression
Gets the right side of the binary expression.

Returns Expression
Inherited from BinaryExpression.getRight
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:5210

getSourceFile

getSourceFile(): SourceFile
Gets the source file.

Returns SourceFile
Inherited from BinaryExpression.getSourceFile
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3740

getStart

getStart(includeJsDocComments?: boolean): number
Gets the source file text position where the node starts that does not include the leading trivia (comments and whitespace).
Parameters
- OptionalincludeJsDocComments: boolean
  Whether to include the JS doc comments.
Returns number
Inherited from BinaryExpression.getStart
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3704

getStartLineNumber

getStartLineNumber(includeJsDocComments?: boolean): number
Gets the line number at the start of the node.
Parameters
- OptionalincludeJsDocComments: boolean
  Whether to include the JS doc comments or not.
Returns number
Inherited from BinaryExpression.getStartLineNumber
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3823

getStartLinePos

getStartLinePos(includeJsDocComments?: boolean): number
Gets the position of the start of the line that this node starts on.
Parameters
- OptionalincludeJsDocComments: boolean
  Whether to include the JS doc comments or not.
Returns number
Inherited from BinaryExpression.getStartLinePos
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3818

getSymbol

getSymbol(): Symbol | undefined
Gets the compiler symbol or undefined if it doesn't exist.

Returns Symbol | undefined
Inherited from BinaryExpression.getSymbol
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3466

getSymbolOrThrow

getSymbolOrThrow(message?: string | (() => string)): Symbol
Gets the symbol or throws an error if it doesn't exist.
Parameters
- Optionalmessage: string | (() => string)
Returns Symbol
Inherited from BinaryExpression.getSymbolOrThrow
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3464

getSymbolsInScope

getSymbolsInScope(meaning: tsc.SymbolFlags): Symbol[]
Gets the symbols in the scope of the node.

Note: This will always return the local symbols. If you want the export symbol from a local symbol, then use the #getExportSymbol() method on the symbol.
Parameters
- meaning: tsc.SymbolFlags
  Meaning of symbol to filter by.
Returns Symbol[]
Inherited from BinaryExpression.getSymbolsInScope
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3474

getText

getText(includeJsDocComments?: boolean): string
Gets the text without leading trivia (comments and whitespace).
Parameters
- OptionalincludeJsDocComments: boolean
  Whether to include the js doc comments when getting the text.
Returns string
Inherited from BinaryExpression.getText
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3726
getText(
    options: {
        includeJsDocComments?: boolean;
        trimLeadingIndentation?: boolean;
    },
): string
Gets the text without leading trivia (comments and whitespace).
Parameters
- options: { includeJsDocComments?: boolean; trimLeadingIndentation?: boolean }
  Options for getting the text.
Returns string
Inherited from BinaryExpression.getText
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3731

getTrailingCommentRanges

getTrailingCommentRanges(): CommentRange[]
Gets the trailing comment ranges of the current node.

Returns CommentRange[]
Inherited from BinaryExpression.getTrailingCommentRanges
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3880

getTrailingTriviaEnd

getTrailingTriviaEnd(): number
Gets the text position of the next significant token or new line.

Returns number
Inherited from BinaryExpression.getTrailingTriviaEnd
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3721

getTrailingTriviaWidth

getTrailingTriviaWidth(): number
Gets the text length from the end of the current node to the next significant token or new line.

Returns number
Inherited from BinaryExpression.getTrailingTriviaWidth
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3719

getType

getType(): Type
Gets the type of the node.

Returns Type
Inherited from BinaryExpression.getType
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3496

getWidth

getWidth(includeJsDocComments?: boolean): number
Gets the text length of the node without trivia.
Parameters
- OptionalincludeJsDocComments: boolean
  Whether to include the JS doc comments in the width or not.
Returns number
Inherited from BinaryExpression.getWidth
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3713

isFirstNodeOnLine

isFirstNodeOnLine(): boolean
Gets if this is the first node on the current line.

Returns boolean
Inherited from BinaryExpression.isFirstNodeOnLine
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3827

isInStringAtPos

isInStringAtPos(pos: number): boolean
Gets if the specified position is within a string.
Parameters
- pos: number
  Position.
Returns boolean
Inherited from BinaryExpression.isInStringAtPos
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3507

isInSyntaxList

isInSyntaxList(): boolean
Gets if this node is in a syntax list.

Returns boolean
Inherited from BinaryExpression.isInSyntaxList
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3793

isKind

isKind<TKind extends tsc.SyntaxKind>(
kind: TKind,
): this is KindToNodeMappings[TKind]
Returns if the node is the specified kind.

This is a type guard.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind.
Returns this is KindToNodeMappings[TKind]
Inherited from BinaryExpression.isKind
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3519

prependWhitespace

prependWhitespace(textOrWriterFunction: string | WriterFunction): void
Prepends the specified whitespace to current node.
Parameters
- textOrWriterFunction: string | WriterFunction
  Text or writer function.
Returns void
Inherited from BinaryExpression.prependWhitespace
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3842

print

print(options?: PrintNodeOptions): string
Prints the node using the compiler's printer.
Parameters
- Optionaloptions: PrintNodeOptions
  Options.
Returns string
Inherited from BinaryExpression.print
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3462

replaceWithText

replaceWithText(textOrWriterFunction: string | WriterFunction): Node
Replaces the text of the current node with new text.

This will forget the current node and return a new node that can be asserted or type guarded to the correct type.
Parameters
- textOrWriterFunction: string | WriterFunction
  Text or writer function to replace with.
Returns Node
The new node.

Remarks
This will replace the text from the Node#getStart(true) position (start position with js docs) to Node#getEnd(). Use Node#getText(true) to get all the text that will be replaced.
Inherited from BinaryExpression.replaceWithText
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3837

transform

transform(visitNode: (traversal: TransformTraversalControl) => tsc.Node): Node
Transforms the node using the compiler api nodes and functions and returns the node that was transformed (experimental).

WARNING: This will forget descendants of transformed nodes and potentially this node.
Parameters
- visitNode: (traversal: TransformTraversalControl) => tsc.Node
Returns Node
Example: Increments all the numeric literals in a source file.
```
sourceFile.transform(traversal => {
  const node = traversal.visitChildren(); // recommend always visiting the children first (post order)
  if (ts.isNumericLiteral(node))
    return ts.createNumericLiteral((parseInt(node.text, 10) + 1).toString());
  return node;
});
```
Example: Updates the class declaration node without visiting the children.
```
const classDec = sourceFile.getClassOrThrow("MyClass");
classDec.transform(traversal => {
  const node = traversal.currentNode;
  return ts.updateClassDeclaration(node, undefined, undefined, ts.createIdentifier("MyUpdatedClass"), undefined, undefined, []);
});
```
Inherited from BinaryExpression.transform
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3876

wasForgotten

wasForgotten(): boolean
Gets if the compiler node was forgotten.

This will be true when the compiler node was forgotten or removed.

Returns boolean
Inherited from BinaryExpression.wasForgotten
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:3451

Interface InstanceofExpression

Hierarchy (View Summary)

Index

Properties

Methods

Properties

compilerNode

Methods

appendWhitespace

Parameters

Returns void

asKind

Type Parameters

Parameters

Returns KindToNodeMappings[TKind] | undefined

asKindOrThrow

Type Parameters

Parameters

Returns KindToNodeMappings[TKind]

containsRange

Parameters

Returns boolean

forEachChild

Type Parameters

Parameters

Returns T | undefined

forEachChildAsArray

Returns Node<tsc.Node>[]

forEachDescendant

Type Parameters

Parameters

Returns T | undefined

Remarks

forEachDescendantAsArray

Returns Node<tsc.Node>[]

forget

Returns void

forgetDescendants

Returns void

formatText

Parameters

Returns void

getAncestors

Returns Node<tsc.Node>[]

getChildAtIndex

Parameters

Returns Node

getChildAtIndexIfKind

Type Parameters

Parameters

Returns KindToNodeMappings[TKind] | undefined

getChildAtIndexIfKindOrThrow

Type Parameters

Parameters

Returns KindToNodeMappings[TKind]

getChildAtPos

Parameters

Returns Node<tsc.Node> | undefined

getChildCount

Returns number

getChildIndentationLevel

Returns number

getChildIndentationText

Parameters

Returns string

getChildIndex

Returns number

getChildren

Returns Node<tsc.Node>[]

getChildrenOfKind

Type Parameters

Parameters

Returns KindToNodeMappings[TKind][]

getChildSyntaxList

Returns SyntaxList | undefined

getChildSyntaxListOrThrow

Parameters

Returns SyntaxList

getCombinedModifierFlags

Returns ModifierFlags