Interface ModifierableNode

interface ModifierableNode {
    getFirstModifierByKind<TKind extends tsc.SyntaxKind>(
        kind: TKind,
    ): KindToNodeMappings[TKind] | undefined;
    getFirstModifierByKindOrThrow<TKind extends tsc.SyntaxKind>(
        kind: TKind,
    ): KindToNodeMappings[TKind];
    getModifiers(): Node<Modifier>[];
    hasModifier(kind: tsc.SyntaxKind): boolean;
    hasModifier(text: ModifierTexts): boolean;
    toggleModifier(text: ModifierTexts, value?: boolean): this;
}

Hierarchy (View Summary)

ModifierableNode
- ClassLikeDeclarationBase
- FunctionLikeDeclaration

Index

Methods

getFirstModifierByKind getFirstModifierByKindOrThrow getModifiers hasModifier toggleModifier

Methods

getFirstModifierByKind

getFirstModifierByKind<TKind extends tsc.SyntaxKind>(
kind: TKind,
): KindToNodeMappings[TKind] | undefined
Gets the first modifier of the specified syntax kind or undefined if none found.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind.
Returns KindToNodeMappings[TKind] | undefined
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:1397

getFirstModifierByKindOrThrow

getFirstModifierByKindOrThrow<TKind extends tsc.SyntaxKind>(
kind: TKind,
): KindToNodeMappings[TKind]
Gets the first modifier of the specified syntax kind or throws if none found.
Type Parameters
- TKind extends tsc.SyntaxKind
Parameters
- kind: TKind
  Syntax kind.
Returns KindToNodeMappings[TKind]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:1392

getModifiers

getModifiers(): Node<Modifier>[]
Gets the node's modifiers.

Returns Node<Modifier>[]
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:1387

hasModifier

hasModifier(kind: tsc.SyntaxKind): boolean
Gets if it has the specified modifier.
Parameters
- kind: tsc.SyntaxKind
  Syntax kind to check for.
Returns boolean
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:1402
hasModifier(text: ModifierTexts): boolean
Gets if it has the specified modifier.
Parameters
- text: ModifierTexts
  Text to check for.
Returns boolean
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:1407

toggleModifier

toggleModifier(text: ModifierTexts, value?: boolean): this
Toggles a modifier.
Parameters
- text: ModifierTexts
  Text to toggle the modifier for.
- Optionalvalue: boolean
  Optional toggling value.
Returns this
- Defined in node_modules/.pnpm/ts-morph@23.0.0/node_modules/ts-morph/lib/ts-morph.d.ts:1413