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 Readonly error

error?: Error

Optional error.

Optional Readonly message

message?: string

Optional message describing the outcome of the action.

Optional Readonly skip

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.

Readonly success

success: boolean

Boolean describing if the action was successful.

Optional Readonly value

value?: any

Optional return value.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc