Interface RunResult<F>

Result returned from run()/runSync() after executing all hook callbacks.

interface RunResult<F extends (...args: any[]) => any = (...args: any[]) => any> {
    args: Parameters<F>;
    result: Awaited<ReturnType<F>> | undefined;
    returned: boolean;
    scope: HookScope;
}

Properties

Current arguments (possibly modified by callbacks)

result: Awaited<ReturnType<F>> | undefined

Result value (if set via ctx.returns())

returned: boolean

Whether a callback short-circuited via return ctx.returns() or return ctx.args()

The scope used during this run (pass to subsequent runs to share state)