Interface HookOutputObject

Output of a life-cycle hook action.

interface HookOutputObject {
    error?: Error;
    message?: string;
    skip?: boolean;
    success: boolean;
    value?: any;
}

Properties

error? message? skip? success value?

Properties

Optional Readonlyerror

error?: Error

Optional error.

Optional Readonlymessage

message?: string

Optional message describing the outcome of the action.

Optional Readonlyskip

skip?: boolean

Optional boolean that can be returned from hooks executed before the stack operation to indicate that the operation should be skipped and all the remaining before hooks should be ignored.

Readonlysuccess

success: boolean

Boolean describing if the action was successful.

Optional Readonlyvalue

value?: any

Optional return value.

Settings

Member Visibility

On This Page

Properties