Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CodeActionKind

Kind of a code action.

Kinds are a hierarchical list of identifiers separated by ., e.g. "refactor.extract.function".

Code action kinds are used by the editor for UI elements such as the refactoring context menu. Users can also trigger code actions with a specific kind with the editor.action.codeAction command.

Hierarchy

  • CodeActionKind

Index

Properties(11)

Static Readonly Empty

Empty kind.

Static Readonly QuickFix

QuickFix: CodeActionKind

Base kind for quickfix actions: quickfix.

Quick fix actions address a problem in the code and are shown in the normal code action context menu.

Static Readonly Refactor

Refactor: CodeActionKind

Base kind for refactoring actions: refactor

Refactoring actions are shown in the refactoring context menu.

Static Readonly RefactorExtract

RefactorExtract: CodeActionKind

Base kind for refactoring extraction actions: refactor.extract

Example extract actions:

  • Extract method
  • Extract function
  • Extract variable
  • Extract interface from class
  • ...

Static Readonly RefactorInline

RefactorInline: CodeActionKind

Base kind for refactoring inline actions: refactor.inline

Example inline actions:

  • Inline function
  • Inline variable
  • Inline constant
  • ...

Static Readonly RefactorMove

RefactorMove: CodeActionKind

Base kind for refactoring move actions: refactor.move

Example move actions:

  • Move a function to a new file
  • Move a property between classes
  • Move method to base class
  • ...

Static Readonly RefactorRewrite

RefactorRewrite: CodeActionKind

Base kind for refactoring rewrite actions: refactor.rewrite

Example rewrite actions:

  • Convert JavaScript function to class
  • Add or remove parameter
  • Encapsulate field
  • Make method static
  • ...

Static Readonly Source

Base kind for source actions: source

Source code actions apply to the entire file. They must be explicitly requested and will not show in the normal lightbulb menu. Source actions can be run on save using editor.codeActionsOnSave and are also shown in the source context menu.

Static Readonly SourceOrganizeImports

SourceOrganizeImports: CodeActionKind

Base kind for an organize imports source action: source.organizeImports.

Static Readonly SourceFixAll

SourceFixAll: CodeActionKind

Base kind for auto-fix source actions: source.fixAll.

Fix all actions automatically fix errors that have a clear fix that do not require user input. They should not suppress errors or perform unsafe fixes such as generating new types or classes.

Readonly value

value: string

String value of the kind, e.g. "refactor.extract.function".

Constructors(1)

Private constructor

Methods(3)

append

  • Create a new kind by appending a more specific selector to the current kind.

    Does not modify the current kind.

    Parameters

    • parts: string

    Returns CodeActionKind

intersects

  • Checks if this code action kind intersects other.

    The kind "refactor.extract" for example intersects refactor, "refactor.extract" and ``"refactor.extract.function", but not "unicorn.refactor.extract", or "refactor.extractAll"`.

    Parameters

    Returns boolean

contains

  • Checks if other is a sub-kind of this CodeActionKind.

    The kind "refactor.extract" for example contains "refactor.extract" and ``"refactor.extract.function", but not "unicorn.refactor.extract", or "refactor.extractAll"orrefactor`.

    Parameters

    Returns boolean

Generated by TypeDoc. Maintained by 洛竹