Interface StatementedNode

interface StatementedNode {
    addClass(
        structure: OptionalKind<ClassDeclarationStructure>,
    ): ClassDeclaration;
    addClasses(
        structures: readonly OptionalKind<ClassDeclarationStructure>[],
    ): ClassDeclaration[];
    addEnum(structure: OptionalKind<EnumDeclarationStructure>): EnumDeclaration;
    addEnums(
        structures: readonly OptionalKind<EnumDeclarationStructure>[],
    ): EnumDeclaration[];
    addFunction(
        structure: OptionalKind<FunctionDeclarationStructure>,
    ): FunctionDeclaration;
    addFunctions(
        structures: readonly OptionalKind<FunctionDeclarationStructure>[],
    ): FunctionDeclaration[];
    addInterface(
        structure: OptionalKind<InterfaceDeclarationStructure>,
    ): InterfaceDeclaration;
    addInterfaces(
        structures: readonly OptionalKind<InterfaceDeclarationStructure>[],
    ): InterfaceDeclaration[];
    addModule(
        structure: OptionalKind<ModuleDeclarationStructure>,
    ): ModuleDeclaration;
    addModules(
        structures: readonly OptionalKind<ModuleDeclarationStructure>[],
    ): ModuleDeclaration[];
    addStatements(
        statements:
            | string
            | WriterFunction
            | readonly (string | WriterFunction | StatementStructures)[],
    ): Statement<tsc.Statement>[];
    addTypeAlias(
        structure: OptionalKind<TypeAliasDeclarationStructure>,
    ): TypeAliasDeclaration;
    addTypeAliases(
        structures: readonly OptionalKind<TypeAliasDeclarationStructure>[],
    ): TypeAliasDeclaration[];
    addVariableStatement(
        structure: OptionalKind<VariableStatementStructure>,
    ): VariableStatement;
    addVariableStatements(
        structures: readonly OptionalKind<VariableStatementStructure>[],
    ): VariableStatement[];
    getClass(name: string): ClassDeclaration | undefined;
    getClass(
        findFunction: (declaration: ClassDeclaration) => boolean,
    ): ClassDeclaration | undefined;
    getClasses(): ClassDeclaration[];
    getClassOrThrow(name: string): ClassDeclaration;
    getClassOrThrow(
        findFunction: (declaration: ClassDeclaration) => boolean,
    ): ClassDeclaration;
    getEnum(name: string): EnumDeclaration | undefined;
    getEnum(
        findFunction: (declaration: EnumDeclaration) => boolean,
    ): EnumDeclaration | undefined;
    getEnumOrThrow(name: string): EnumDeclaration;
    getEnumOrThrow(
        findFunction: (declaration: EnumDeclaration) => boolean,
    ): EnumDeclaration;
    getEnums(): EnumDeclaration[];
    getFunction(name: string): FunctionDeclaration | undefined;
    getFunction(
        findFunction: (declaration: FunctionDeclaration) => boolean,
    ): FunctionDeclaration | undefined;
    getFunctionOrThrow(name: string): FunctionDeclaration;
    getFunctionOrThrow(
        findFunction: (declaration: FunctionDeclaration) => boolean,
    ): FunctionDeclaration;
    getFunctions(): FunctionDeclaration[];
    getInterface(name: string): InterfaceDeclaration | undefined;
    getInterface(
        findFunction: (declaration: InterfaceDeclaration) => boolean,
    ): InterfaceDeclaration | undefined;
    getInterfaceOrThrow(name: string): InterfaceDeclaration;
    getInterfaceOrThrow(
        findFunction: (declaration: InterfaceDeclaration) => boolean,
    ): InterfaceDeclaration;
    getInterfaces(): InterfaceDeclaration[];
    getModule(name: string): ModuleDeclaration | undefined;
    getModule(
        findFunction: (declaration: ModuleDeclaration) => boolean,
    ): ModuleDeclaration | undefined;
    getModuleOrThrow(name: string): ModuleDeclaration;
    getModuleOrThrow(
        findFunction: (declaration: ModuleDeclaration) => boolean,
    ): ModuleDeclaration;
    getModules(): ModuleDeclaration[];
    getStatement<T extends Statement<tsc.Statement>>(
        findFunction: (statement: Statement) => statement is T,
    ): T | undefined;
    getStatement(
        findFunction: (statement: Statement) => boolean,
    ): Statement<tsc.Statement> | undefined;
    getStatementByKind<TKind extends tsc.SyntaxKind>(
        kind: TKind,
    ): KindToNodeMappingsWithCommentStatements[TKind] | undefined;
    getStatementByKindOrThrow<TKind extends tsc.SyntaxKind>(
        kind: TKind,
    ): KindToNodeMappingsWithCommentStatements[TKind];
    getStatementOrThrow<T extends Statement<tsc.Statement>>(
        findFunction: (statement: Statement) => statement is T,
    ): T;
    getStatementOrThrow(
        findFunction: (statement: Statement) => boolean,
    ): Statement;
    getStatements(): Statement<tsc.Statement>[];
    getStatementsWithComments(): Statement<tsc.Statement>[];
    getTypeAlias(name: string): TypeAliasDeclaration | undefined;
    getTypeAlias(
        findFunction: (declaration: TypeAliasDeclaration) => boolean,
    ): TypeAliasDeclaration | undefined;
    getTypeAliases(): TypeAliasDeclaration[];
    getTypeAliasOrThrow(name: string): TypeAliasDeclaration;
    getTypeAliasOrThrow(
        findFunction: (declaration: TypeAliasDeclaration) => boolean,
    ): TypeAliasDeclaration;
    getVariableDeclaration(name: string): VariableDeclaration | undefined;
    getVariableDeclaration(
        findFunction: (declaration: VariableDeclaration) => boolean,
    ): VariableDeclaration | undefined;
    getVariableDeclarationOrThrow(name: string): VariableDeclaration;
    getVariableDeclarationOrThrow(
        findFunction: (declaration: VariableDeclaration) => boolean,
    ): VariableDeclaration;
    getVariableDeclarations(): VariableDeclaration[];
    getVariableStatement(name: string): VariableStatement | undefined;
    getVariableStatement(
        findFunction: (declaration: VariableStatement) => boolean,
    ): VariableStatement | undefined;
    getVariableStatementOrThrow(name: string): VariableStatement;
    getVariableStatementOrThrow(
        findFunction: (declaration: VariableStatement) => boolean,
    ): VariableStatement;
    getVariableStatements(): VariableStatement[];
    insertClass(
        index: number,
        structure: OptionalKind<ClassDeclarationStructure>,
    ): ClassDeclaration;
    insertClasses(
        index: number,
        structures: readonly OptionalKind<ClassDeclarationStructure>[],
    ): ClassDeclaration[];
    insertEnum(
        index: number,
        structure: OptionalKind<EnumDeclarationStructure>,
    ): EnumDeclaration;
    insertEnums(
        index: number,
        structures: readonly OptionalKind<EnumDeclarationStructure>[],
    ): EnumDeclaration[];
    insertFunction(
        index: number,
        structure: OptionalKind<FunctionDeclarationStructure>,
    ): FunctionDeclaration;
    insertFunctions(
        index: number,
        structures: readonly OptionalKind<FunctionDeclarationStructure>[],
    ): FunctionDeclaration[];
    insertInterface(
        index: number,
        structure: OptionalKind<InterfaceDeclarationStructure>,
    ): InterfaceDeclaration;
    insertInterfaces(
        index: number,
        structures: readonly OptionalKind<InterfaceDeclarationStructure>[],
    ): InterfaceDeclaration[];
    insertModule(
        index: number,
        structure: OptionalKind<ModuleDeclarationStructure>,
    ): ModuleDeclaration;
    insertModules(
        index: number,
        structures: readonly OptionalKind<ModuleDeclarationStructure>[],
    ): ModuleDeclaration[];
    insertStatements(
        index: number,
        statements:
            | string
            | WriterFunction
            | readonly (string | WriterFunction | StatementStructures)[],
    ): Statement<tsc.Statement>[];
    insertTypeAlias(
        index: number,
        structure: OptionalKind<TypeAliasDeclarationStructure>,
    ): TypeAliasDeclaration;
    insertTypeAliases(
        index: number,
        structures: readonly OptionalKind<TypeAliasDeclarationStructure>[],
    ): TypeAliasDeclaration[];
    insertVariableStatement(
        index: number,
        structure: OptionalKind<VariableStatementStructure>,
    ): VariableStatement;
    insertVariableStatements(
        index: number,
        structures: readonly OptionalKind<VariableStatementStructure>[],
    ): VariableStatement[];
    removeStatement(index: number): this;
    removeStatements(indexRange: [number, number]): this;
}

Hierarchy (View Summary)

StatementedNode
- FunctionLikeDeclaration

Index

Methods

addClass addClasses addEnum addEnums addFunction addFunctions addInterface addInterfaces addModule addModules addStatements addTypeAlias addTypeAliases addVariableStatement addVariableStatements getClass getClasses getClassOrThrow getEnum getEnumOrThrow getEnums getFunction getFunctionOrThrow getFunctions getInterface getInterfaceOrThrow getInterfaces getModule getModuleOrThrow getModules getStatement getStatementByKind getStatementByKindOrThrow getStatementOrThrow getStatements getStatementsWithComments getTypeAlias getTypeAliases getTypeAliasOrThrow getVariableDeclaration getVariableDeclarationOrThrow getVariableDeclarations getVariableStatement getVariableStatementOrThrow getVariableStatements insertClass insertClasses insertEnum insertEnums insertFunction insertFunctions insertInterface insertInterfaces insertModule insertModules insertStatements insertTypeAlias insertTypeAliases insertVariableStatement insertVariableStatements removeStatement removeStatements

Methods

addClass

addClass(structure: OptionalKind<ClassDeclarationStructure>): ClassDeclaration
Adds an class declaration as a child.
Parameters
- structure: OptionalKind<ClassDeclarationStructure>
  Structure of the class declaration to add.
Returns ClassDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8095

addClasses

addClasses(
structures: readonly OptionalKind<ClassDeclarationStructure>[],
): ClassDeclaration[]
Adds class declarations as a child.
Parameters
- structures: readonly OptionalKind<ClassDeclarationStructure>[]
  Structures of the class declarations to add.
Returns ClassDeclaration[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8100

addEnum

addEnum(structure: OptionalKind<EnumDeclarationStructure>): EnumDeclaration
Adds an enum declaration as a child.
Parameters
- structure: OptionalKind<EnumDeclarationStructure>
  Structure of the enum declaration to add.
Returns EnumDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8139

addEnums

addEnums(
structures: readonly OptionalKind<EnumDeclarationStructure>[],
): EnumDeclaration[]
Adds enum declarations as a child.
Parameters
- structures: readonly OptionalKind<EnumDeclarationStructure>[]
  Structures of the enum declarations to add.
Returns EnumDeclaration[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8144

addFunction

addFunction(
structure: OptionalKind<FunctionDeclarationStructure>,
): FunctionDeclaration
Adds a function declaration as a child.
Parameters
- structure: OptionalKind<FunctionDeclarationStructure>
  Structure of the function declaration to add.
Returns FunctionDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8183

addFunctions

addFunctions(
structures: readonly OptionalKind<FunctionDeclarationStructure>[],
): FunctionDeclaration[]
Adds function declarations as a child.
Parameters
- structures: readonly OptionalKind<FunctionDeclarationStructure>[]
  Structures of the function declarations to add.
Returns FunctionDeclaration[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8188

addInterface

addInterface(
structure: OptionalKind<InterfaceDeclarationStructure>,
): InterfaceDeclaration
Adds a interface declaration as a child.
Parameters
- structure: OptionalKind<InterfaceDeclarationStructure>
  Structure of the interface declaration to add.
Returns InterfaceDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8227

addInterfaces

addInterfaces(
structures: readonly OptionalKind<InterfaceDeclarationStructure>[],
): InterfaceDeclaration[]
Adds interface declarations as a child.
Parameters
- structures: readonly OptionalKind<InterfaceDeclarationStructure>[]
  Structures of the interface declarations to add.
Returns InterfaceDeclaration[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8232

addModule

addModule(
structure: OptionalKind<ModuleDeclarationStructure>,
): ModuleDeclaration
Adds a module declaration as a child.
Parameters
- structure: OptionalKind<ModuleDeclarationStructure>
  Structure of the namespace declaration to add.
Returns ModuleDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8271

addModules

addModules(
structures: readonly OptionalKind<ModuleDeclarationStructure>[],
): ModuleDeclaration[]
Adds module declarations as a child.
Parameters
- structures: readonly OptionalKind<ModuleDeclarationStructure>[]
  Structures of the namespace declarations to add.
Returns ModuleDeclaration[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8276

addStatements

addStatements(
    statements:
        | string
        | WriterFunction
        | readonly (string | WriterFunction | StatementStructures)[],
): Statement<tsc.Statement>[]
Add statements.
Parameters
- statements:
      | string
      | WriterFunction
      | readonly (string | WriterFunction | StatementStructures)[]
  statements to add.
Returns Statement<tsc.Statement>[]
The statements that were added.
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8073

addTypeAlias

addTypeAlias(
structure: OptionalKind<TypeAliasDeclarationStructure>,
): TypeAliasDeclaration
Adds a type alias declaration as a child.
Parameters
- structure: OptionalKind<TypeAliasDeclarationStructure>
  Structure of the type alias declaration to add.
Returns TypeAliasDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8315

addTypeAliases

addTypeAliases(
structures: readonly OptionalKind<TypeAliasDeclarationStructure>[],
): TypeAliasDeclaration[]
Adds type alias declarations as a child.
Parameters
- structures: readonly OptionalKind<TypeAliasDeclarationStructure>[]
  Structures of the type alias declarations to add.
Returns TypeAliasDeclaration[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8320

addVariableStatement

addVariableStatement(
structure: OptionalKind<VariableStatementStructure>,
): VariableStatement
Adds a variable statement.
Parameters
- structure: OptionalKind<VariableStatementStructure>
  Structure of the variable statement.
Returns VariableStatement
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8359

addVariableStatements

addVariableStatements(
structures: readonly OptionalKind<VariableStatementStructure>[],
): VariableStatement[]
Adds variable statements.
Parameters
- structures: readonly OptionalKind<VariableStatementStructure>[]
  Structures of the variable statements.
Returns VariableStatement[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8364

getClass

getClass(name: string): ClassDeclaration | undefined
Gets a class.
Parameters
- name: string
  Name of the class.
Returns ClassDeclaration | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8119
getClass(
findFunction: (declaration: ClassDeclaration) => boolean,
): ClassDeclaration | undefined
Gets a class.
Parameters
- findFunction: (declaration: ClassDeclaration) => boolean
  Function to use to find the class.
Returns ClassDeclaration | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8124

getClasses

getClasses(): ClassDeclaration[]
Gets the direct class declaration children.

Returns ClassDeclaration[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8114

getClassOrThrow

getClassOrThrow(name: string): ClassDeclaration
Gets a class or throws if it doesn't exist.
Parameters
- name: string
  Name of the class.
Returns ClassDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8129
getClassOrThrow(
findFunction: (declaration: ClassDeclaration) => boolean,
): ClassDeclaration
Gets a class or throws if it doesn't exist.
Parameters
- findFunction: (declaration: ClassDeclaration) => boolean
  Function to use to find the class.
Returns ClassDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8134

getEnum

getEnum(name: string): EnumDeclaration | undefined
Gets an enum.
Parameters
- name: string
  Name of the enum.
Returns EnumDeclaration | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8163
getEnum(
findFunction: (declaration: EnumDeclaration) => boolean,
): EnumDeclaration | undefined
Gets an enum.
Parameters
- findFunction: (declaration: EnumDeclaration) => boolean
  Function to use to find the enum.
Returns EnumDeclaration | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8168

getEnumOrThrow

getEnumOrThrow(name: string): EnumDeclaration
Gets an enum or throws if it doesn't exist.
Parameters
- name: string
  Name of the enum.
Returns EnumDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8173
getEnumOrThrow(
findFunction: (declaration: EnumDeclaration) => boolean,
): EnumDeclaration
Gets an enum or throws if it doesn't exist.
Parameters
- findFunction: (declaration: EnumDeclaration) => boolean
  Function to use to find the enum.
Returns EnumDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8178

getEnums

getEnums(): EnumDeclaration[]
Gets the direct enum declaration children.

Returns EnumDeclaration[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8158

getFunction

getFunction(name: string): FunctionDeclaration | undefined
Gets a function.
Parameters
- name: string
  Name of the function.
Returns FunctionDeclaration | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8207
getFunction(
findFunction: (declaration: FunctionDeclaration) => boolean,
): FunctionDeclaration | undefined
Gets a function.
Parameters
- findFunction: (declaration: FunctionDeclaration) => boolean
  Function to use to find the function.
Returns FunctionDeclaration | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8212

getFunctionOrThrow

getFunctionOrThrow(name: string): FunctionDeclaration
Gets a function or throws if it doesn't exist.
Parameters
- name: string
  Name of the function.
Returns FunctionDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8217
getFunctionOrThrow(
findFunction: (declaration: FunctionDeclaration) => boolean,
): FunctionDeclaration
Gets a function or throws if it doesn't exist.
Parameters
- findFunction: (declaration: FunctionDeclaration) => boolean
  Function to use to find the function.
Returns FunctionDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8222

getFunctions

getFunctions(): FunctionDeclaration[]
Gets the direct function declaration children.

Returns FunctionDeclaration[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8202

getInterface

getInterface(name: string): InterfaceDeclaration | undefined
Gets an interface.
Parameters
- name: string
  Name of the interface.
Returns InterfaceDeclaration | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8251
getInterface(
findFunction: (declaration: InterfaceDeclaration) => boolean,
): InterfaceDeclaration | undefined
Gets an interface.
Parameters
- findFunction: (declaration: InterfaceDeclaration) => boolean
  Function to use to find the interface.
Returns InterfaceDeclaration | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8256

getInterfaceOrThrow

getInterfaceOrThrow(name: string): InterfaceDeclaration
Gets an interface or throws if it doesn't exist.
Parameters
- name: string
  Name of the interface.
Returns InterfaceDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8261
getInterfaceOrThrow(
findFunction: (declaration: InterfaceDeclaration) => boolean,
): InterfaceDeclaration
Gets an interface or throws if it doesn't exist.
Parameters
- findFunction: (declaration: InterfaceDeclaration) => boolean
  Function to use to find the interface.
Returns InterfaceDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8266

getInterfaces

getInterfaces(): InterfaceDeclaration[]
Gets the direct interface declaration children.

Returns InterfaceDeclaration[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8246

getModule

getModule(name: string): ModuleDeclaration | undefined
Gets a module declaration child by name.
Parameters
- name: string
  Name of the namespace.
Returns ModuleDeclaration | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8295
getModule(
findFunction: (declaration: ModuleDeclaration) => boolean,
): ModuleDeclaration | undefined
Gets a module declaration child by condition.
Parameters
- findFunction: (declaration: ModuleDeclaration) => boolean
  Function to use to find the namespace.
Returns ModuleDeclaration | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8300

getModuleOrThrow

getModuleOrThrow(name: string): ModuleDeclaration
Gets a module declaration child by name or throws if it doesn't exist.
Parameters
- name: string
  Name of the namespace.
Returns ModuleDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8305
getModuleOrThrow(
findFunction: (declaration: ModuleDeclaration) => boolean,
): ModuleDeclaration
Gets a module declaration child by condition or throws if it doesn't exist.
Parameters
- findFunction: (declaration: ModuleDeclaration) => boolean
  Function to use to find the namespace.
Returns ModuleDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8310

getModules

getModules(): ModuleDeclaration[]
Gets the module declaration children.

Returns ModuleDeclaration[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8290

getStatement

getStatement<T extends Statement<tsc.Statement>>(
findFunction: (statement: Statement) => statement is T,
): T | undefined
Gets the first statement that matches the provided condition or returns undefined if it doesn't exist.
Type Parameters
- T extends Statement<tsc.Statement>
Parameters
- findFunction: (statement: Statement) => statement is T
  Function to find the statement by.
Returns T | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8042
getStatement(
findFunction: (statement: Statement) => boolean,
): Statement<tsc.Statement> | undefined
Gets the first statement that matches the provided condition or returns undefined if it doesn't exist.
Parameters
- findFunction: (statement: Statement) => boolean
  Function to find the statement by.
Returns Statement<tsc.Statement> | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8047

getStatementByKind

getStatementByKind<TKind extends tsc.SyntaxKind>(
kind: TKind,
): KindToNodeMappingsWithCommentStatements[TKind] | undefined
Gets the first statement that matches the provided syntax kind or returns undefined if it doesn't exist.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind to find the node by.
Returns KindToNodeMappingsWithCommentStatements[TKind] | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8062

getStatementByKindOrThrow

getStatementByKindOrThrow<TKind extends tsc.SyntaxKind>(
kind: TKind,
): KindToNodeMappingsWithCommentStatements[TKind]
Gets the first statement that matches the provided syntax kind or throws if it doesn't exist.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind to find the node by.
Returns KindToNodeMappingsWithCommentStatements[TKind]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8067

getStatementOrThrow

getStatementOrThrow<T extends Statement<tsc.Statement>>(
findFunction: (statement: Statement) => statement is T,
): T
Gets the first statement that matches the provided condition or throws if it doesn't exist.
Type Parameters
- T extends Statement<tsc.Statement>
Parameters
- findFunction: (statement: Statement) => statement is T
  Function to find the statement by.
Returns T
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8052
getStatementOrThrow(findFunction: (statement: Statement) => boolean): Statement
Gets the first statement that matches the provided condition or throws if it doesn't exist.
Parameters
- findFunction: (statement: Statement) => boolean
  Function to find the statement by.
Returns Statement
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8057

getStatements

getStatements(): Statement<tsc.Statement>[]
Gets the node's statements.

Returns Statement<tsc.Statement>[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8035

getStatementsWithComments

getStatementsWithComments(): Statement<tsc.Statement>[]
Gets the node's statements with comment statements.

Returns Statement<tsc.Statement>[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8037

getTypeAlias

getTypeAlias(name: string): TypeAliasDeclaration | undefined
Gets a type alias.
Parameters
- name: string
  Name of the type alias.
Returns TypeAliasDeclaration | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8339
getTypeAlias(
findFunction: (declaration: TypeAliasDeclaration) => boolean,
): TypeAliasDeclaration | undefined
Gets a type alias.
Parameters
- findFunction: (declaration: TypeAliasDeclaration) => boolean
  Function to use to find the type alias.
Returns TypeAliasDeclaration | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8344

getTypeAliases

getTypeAliases(): TypeAliasDeclaration[]
Gets the direct type alias declaration children.

Returns TypeAliasDeclaration[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8334

getTypeAliasOrThrow

getTypeAliasOrThrow(name: string): TypeAliasDeclaration
Gets a type alias or throws if it doesn't exist.
Parameters
- name: string
  Name of the type alias.
Returns TypeAliasDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8349
getTypeAliasOrThrow(
findFunction: (declaration: TypeAliasDeclaration) => boolean,
): TypeAliasDeclaration
Gets a type alias or throws if it doesn't exist.
Parameters
- findFunction: (declaration: TypeAliasDeclaration) => boolean
  Function to use to find the type alias.
Returns TypeAliasDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8354

getVariableDeclaration

getVariableDeclaration(name: string): VariableDeclaration | undefined
Gets a variable declaration.
Parameters
- name: string
  Name of the variable declaration.
Returns VariableDeclaration | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8406
getVariableDeclaration(
findFunction: (declaration: VariableDeclaration) => boolean,
): VariableDeclaration | undefined
Gets a variable declaration.
Parameters
- findFunction: (declaration: VariableDeclaration) => boolean
  Function to use to find the variable declaration.
Returns VariableDeclaration | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8411

getVariableDeclarationOrThrow

getVariableDeclarationOrThrow(name: string): VariableDeclaration
Gets a variable declaration or throws if it doesn't exist.
Parameters
- name: string
  Name of the variable declaration.
Returns VariableDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8416
getVariableDeclarationOrThrow(
findFunction: (declaration: VariableDeclaration) => boolean,
): VariableDeclaration
Gets a variable declaration or throws if it doesn't exist.
Parameters
- findFunction: (declaration: VariableDeclaration) => boolean
  Function to use to find the variable declaration.
Returns VariableDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8421

getVariableDeclarations

getVariableDeclarations(): VariableDeclaration[]
Gets all the variable declarations within the variable statement children.

Returns VariableDeclaration[]
Remarks
This does not return the variable declarations within for statements or for of statements.
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8401

getVariableStatement

getVariableStatement(name: string): VariableStatement | undefined
Gets a variable statement.
Parameters
- name: string
  Name of one of the variable statement's declarations.
Returns VariableStatement | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8381
getVariableStatement(
findFunction: (declaration: VariableStatement) => boolean,
): VariableStatement | undefined
Gets a variable statement.
Parameters
- findFunction: (declaration: VariableStatement) => boolean
  Function to use to find the variable statement.
Returns VariableStatement | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8386

getVariableStatementOrThrow

getVariableStatementOrThrow(name: string): VariableStatement
Gets a variable statement or throws if it doesn't exist.
Parameters
- name: string
  Name of one of the variable statement's declarations.
Returns VariableStatement
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8391
getVariableStatementOrThrow(
findFunction: (declaration: VariableStatement) => boolean,
): VariableStatement
Gets a variable statement or throws if it doesn't exist.
Parameters
- findFunction: (declaration: VariableStatement) => boolean
  Function to use to find the variable statement.
Returns VariableStatement
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8396

getVariableStatements

getVariableStatements(): VariableStatement[]
Gets the direct variable statement children.

Returns VariableStatement[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8376

insertClass

insertClass(
index: number,
structure: OptionalKind<ClassDeclarationStructure>,
): ClassDeclaration
Inserts an class declaration as a child.
Parameters
- index: number
  Child index to insert at.
- structure: OptionalKind<ClassDeclarationStructure>
  Structure of the class declaration to insert.
Returns ClassDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8106

insertClasses

insertClasses(
index: number,
structures: readonly OptionalKind<ClassDeclarationStructure>[],
): ClassDeclaration[]
Inserts class declarations as a child.
Parameters
- index: number
  Child index to insert at.
- structures: readonly OptionalKind<ClassDeclarationStructure>[]
  Structures of the class declarations to insert.
Returns ClassDeclaration[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8112

insertEnum

insertEnum(
index: number,
structure: OptionalKind<EnumDeclarationStructure>,
): EnumDeclaration
Inserts an enum declaration as a child.
Parameters
- index: number
  Child index to insert at.
- structure: OptionalKind<EnumDeclarationStructure>
  Structure of the enum declaration to insert.
Returns EnumDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8150

insertEnums

insertEnums(
index: number,
structures: readonly OptionalKind<EnumDeclarationStructure>[],
): EnumDeclaration[]
Inserts enum declarations as a child.
Parameters
- index: number
  Child index to insert at.
- structures: readonly OptionalKind<EnumDeclarationStructure>[]
  Structures of the enum declarations to insert.
Returns EnumDeclaration[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8156

insertFunction

insertFunction(
index: number,
structure: OptionalKind<FunctionDeclarationStructure>,
): FunctionDeclaration
Inserts an function declaration as a child.
Parameters
- index: number
  Child index to insert at.
- structure: OptionalKind<FunctionDeclarationStructure>
  Structure of the function declaration to insert.
Returns FunctionDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8194

insertFunctions

insertFunctions(
index: number,
structures: readonly OptionalKind<FunctionDeclarationStructure>[],
): FunctionDeclaration[]
Inserts function declarations as a child.
Parameters
- index: number
  Child index to insert at.
- structures: readonly OptionalKind<FunctionDeclarationStructure>[]
  Structures of the function declarations to insert.
Returns FunctionDeclaration[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8200

insertInterface

insertInterface(
index: number,
structure: OptionalKind<InterfaceDeclarationStructure>,
): InterfaceDeclaration
Inserts an interface declaration as a child.
Parameters
- index: number
  Child index to insert at.
- structure: OptionalKind<InterfaceDeclarationStructure>
  Structure of the interface declaration to insert.
Returns InterfaceDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8238

insertInterfaces

insertInterfaces(
index: number,
structures: readonly OptionalKind<InterfaceDeclarationStructure>[],
): InterfaceDeclaration[]
Inserts interface declarations as a child.
Parameters
- index: number
  Child index to insert at.
- structures: readonly OptionalKind<InterfaceDeclarationStructure>[]
  Structures of the interface declarations to insert.
Returns InterfaceDeclaration[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8244

insertModule

insertModule(
index: number,
structure: OptionalKind<ModuleDeclarationStructure>,
): ModuleDeclaration
Inserts a module declaration as a child.
Parameters
- index: number
  Child index to insert at.
- structure: OptionalKind<ModuleDeclarationStructure>
  Structure of the namespace declaration to insert.
Returns ModuleDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8282

insertModules

insertModules(
index: number,
structures: readonly OptionalKind<ModuleDeclarationStructure>[],
): ModuleDeclaration[]
Inserts module declarations as children.
Parameters
- index: number
  Child index to insert at.
- structures: readonly OptionalKind<ModuleDeclarationStructure>[]
  Structures of the namespace declarations to insert.
Returns ModuleDeclaration[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8288

insertStatements

insertStatements(
    index: number,
    statements:
        | string
        | WriterFunction
        | readonly (string | WriterFunction | StatementStructures)[],
): Statement<tsc.Statement>[]
Inserts statements at the specified index.
Parameters
- index: number
  Child index to insert at.
- statements:
      | string
      | WriterFunction
      | readonly (string | WriterFunction | StatementStructures)[]
  Statements to insert.
Returns Statement<tsc.Statement>[]
The statements that were inserted.
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8080

insertTypeAlias

insertTypeAlias(
index: number,
structure: OptionalKind<TypeAliasDeclarationStructure>,
): TypeAliasDeclaration
Inserts an type alias declaration as a child.
Parameters
- index: number
  Child index to insert at.
- structure: OptionalKind<TypeAliasDeclarationStructure>
  Structure of the type alias declaration to insert.
Returns TypeAliasDeclaration
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8326

insertTypeAliases

insertTypeAliases(
index: number,
structures: readonly OptionalKind<TypeAliasDeclarationStructure>[],
): TypeAliasDeclaration[]
Inserts type alias declarations as a child.
Parameters
- index: number
  Child index to insert at.
- structures: readonly OptionalKind<TypeAliasDeclarationStructure>[]
  Structures of the type alias declarations to insert.
Returns TypeAliasDeclaration[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8332

insertVariableStatement

insertVariableStatement(
index: number,
structure: OptionalKind<VariableStatementStructure>,
): VariableStatement
Inserts a variable statement.
Parameters
- index: number
- structure: OptionalKind<VariableStatementStructure>
  Structure of the variable statement.
Returns VariableStatement
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8369

insertVariableStatements

insertVariableStatements(
index: number,
structures: readonly OptionalKind<VariableStatementStructure>[],
): VariableStatement[]
Inserts variable statements.
Parameters
- index: number
- structures: readonly OptionalKind<VariableStatementStructure>[]
  Structures of the variable statements.
Returns VariableStatement[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8374

removeStatement

removeStatement(index: number): this
Removes the statement at the specified index.
Parameters
- index: number
  Child index to remove the statement at.
Returns this
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8085

removeStatements

removeStatements(indexRange: [number, number]): this
Removes the statements at the specified index range.
Parameters
- indexRange: [number, number]
  The start and end inclusive index range to remove.
Returns this
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:8090

Interface StatementedNode

Hierarchy (View Summary)

Index

Methods

Methods

addClass

Parameters

Returns ClassDeclaration

addClasses

Parameters

Returns ClassDeclaration[]

addEnum

Parameters

Returns EnumDeclaration

addEnums

Parameters

Returns EnumDeclaration[]

addFunction

Parameters

Returns FunctionDeclaration

addFunctions

Parameters

Returns FunctionDeclaration[]

addInterface

Parameters

Returns InterfaceDeclaration

addInterfaces

Parameters

Returns InterfaceDeclaration[]

addModule

Parameters

Returns ModuleDeclaration

addModules

Parameters

Returns ModuleDeclaration[]

addStatements

Parameters

Returns Statement<tsc.Statement>[]

addTypeAlias

Parameters

Returns TypeAliasDeclaration

addTypeAliases

Parameters

Returns TypeAliasDeclaration[]

addVariableStatement

Parameters

Returns VariableStatement

addVariableStatements

Parameters

Returns VariableStatement[]

getClass

Parameters

Returns ClassDeclaration | undefined

Parameters

Returns ClassDeclaration | undefined

getClasses

Returns ClassDeclaration[]

getClassOrThrow

Parameters

Returns ClassDeclaration

Parameters

Returns ClassDeclaration

getEnum

Parameters

Returns EnumDeclaration | undefined

Parameters

Returns EnumDeclaration | undefined

getEnumOrThrow

Parameters

Returns EnumDeclaration

Parameters

Returns EnumDeclaration

getEnums

Returns EnumDeclaration[]

getFunction

Parameters

Returns FunctionDeclaration | undefined

Parameters

Returns FunctionDeclaration | undefined

getFunctionOrThrow