Interface OnWillStopAction<T>

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

Type Parameters

  • T = unknown

Properties

action prepare? priority? reason

Properties

action

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

Type declaration

Resolves

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

Optional prepare

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

Type declaration

Resolves

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

Optional priority

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

reason: string

A descriptive string for the reason preventing close.

Settings

Member Visibility

Theme

On This Page

actionpreparepriorityreason