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

    Interface OnWillStopAction<T>

    interface OnWillStopAction<T = unknown> {
        action: (prepared: T, stopReason?: StopReason) => MaybePromise<boolean>;
        prepare?: (stopReason?: StopReason) => MaybePromise<T>;
        priority?: number;
        reason: string;
    }

    Type Parameters

    • T = unknown
    Index

    Properties

    action prepare? priority? reason

    Properties

    action: (prepared: T, stopReason?: StopReason) => MaybePromise<boolean>

    to true if it is safe to close the application; false otherwise.

    prepare?: (stopReason?: StopReason) => MaybePromise<T>

    to a prepared value to be passed into the action function.

    priority?: number

    A number representing priority. Higher priority items are run later. High priority implies that some options of this check will have negative impacts if the user subsequently cancels the shutdown.

    reason: string

    A descriptive string for the reason preventing close.

    Settings

    Member Visibility

    On This Page

    Properties