Theia API Documentation v1.65.0
    Preparing search index...

    Interface MonacoCodeActionService

    Partially copied from https://github.com/microsoft/vscode/blob/f66e839a38dfe39ee66a86619a790f9c2336d698/src/vs/workbench/contrib/codeEditor/browser/saveParticipants.ts#L272

    interface MonacoCodeActionService {
        applyCodeActions(
            model: ITextModel,
            codeActionSets: CodeActionSet[],
            token: CancellationToken,
        ): Promise<void>;
        applyOnSaveCodeActions(
            model: ITextModel,
            languageId: string,
            uri: string,
            token: CancellationToken,
        ): Promise<void>;
        getAllCodeActionsOnSave(
            model: ITextModel,
            languageId: string,
            uri: string,
            token: CancellationToken,
        ): Promise<undefined | CodeActionSet[]>;
    }

    Implemented by

    Index

    Methods

    applyCodeActions applyOnSaveCodeActions getAllCodeActionsOnSave

    Methods

    • Applies all code actions that should be run on save for the given model and language identifier. This is a convenience method that retrieves all on-save code actions and applies them.

      Parameters

      • model: ITextModel

        The text model to apply code actions to

      • languageId: string

        The language identifier for preference lookup

      • uri: string

        The URI string for preference scoping

      • token: CancellationToken

        Cancellation token

      Returns Promise<void>

    • Gets all code actions that should be applied on save for the given model and language identifier.

      Parameters

      • model: ITextModel

        The text model to get code actions for

      • languageId: string

        The language identifier for preference lookup

      • uri: string

        The URI string for preference scoping

      • token: CancellationToken

        Cancellation token

      Returns Promise<undefined | CodeActionSet[]>

      Array of code action sets to apply, or undefined if no actions should be applied

    Settings

    Member Visibility

    On This Page

    Methods