Interface BaseHook<T, BeforeHookReturn, HooksReturn>

interface BaseHook<T, BeforeHookReturn, HooksReturn> {
    after?(hookContext, evaluationDetails, hookHints?): HooksReturn;
    before?(hookContext, hookHints?): BeforeHookReturn;
    error?(hookContext, error, hookHints?): HooksReturn;
    finally?(hookContext, hookHints?): HooksReturn;
}

Type Parameters

T extends FlagValue = FlagValue
BeforeHookReturn = unknown
HooksReturn = unknown

Index

Methods

after? before? error? finally?

Methods

`Optional` after

after(hookContext, evaluationDetails, hookHints?): HooksReturn
Runs after flag values are successfully resolved from the provider.
Parameters
- hookContext: Readonly<HookContext<T>>
- evaluationDetails: EvaluationDetails<T>
- Optional hookHints: Readonly<Record<string, unknown>>
Returns HooksReturn
- Defined in packages/shared/src/hooks/hook.ts:19

`Optional` before

before(hookContext, hookHints?): BeforeHookReturn
Runs before flag values are resolved from the provider. If an EvaluationContext is returned, it will be merged with the pre-existing EvaluationContext.
Parameters
- hookContext: BeforeHookContext
- Optional hookHints: Readonly<Record<string, unknown>>
Returns BeforeHookReturn
- Defined in packages/shared/src/hooks/hook.ts:11

`Optional` error

error(hookContext, error, hookHints?): HooksReturn
Runs in the event of an unhandled error or promise rejection during flag resolution, or any attached hooks.
Parameters
- hookContext: Readonly<HookContext<T>>
- error: unknown
- Optional hookHints: Readonly<Record<string, unknown>>
Returns HooksReturn
- Defined in packages/shared/src/hooks/hook.ts:31

`Optional` finally

finally(hookContext, hookHints?): HooksReturn
Runs after all other hook stages, regardless of success or error. Errors thrown here are unhandled by the client and will surface in application code.
Parameters
- hookContext: Readonly<HookContext<T>>
- Optional hookHints: Readonly<Record<string, unknown>>
Returns HooksReturn
- Defined in packages/shared/src/hooks/hook.ts:39

Generated using TypeDoc