Takomo v7.4.3
    Preparing search index...

    Interface HookOutputObject

    Output of a life-cycle hook action.

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

    Properties

    error? message? skip? success value?

    Properties

    error?: Error

    Optional error.

    message?: string

    Optional message describing the outcome of the action.

    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.

    success: boolean

    Boolean describing if the action was successful.

    value?: any

    Optional return value.

    Settings

    Member Visibility

    On This Page

    Properties