@launchdarkly/js-server-sdk-common - v2.26.1
    Preparing search index...

    Interface Hook

    Interface for extending SDK functionality via hooks.

    interface Hook {
        afterEvaluation?(
            hookContext: EvaluationSeriesContext,
            data: EvaluationSeriesData,
            detail: LDEvaluationDetail,
        ): EvaluationSeriesData;
        beforeEvaluation?(
            hookContext: EvaluationSeriesContext,
            data: EvaluationSeriesData,
        ): EvaluationSeriesData;
        getMetadata(): HookMetadata;
    }
    Index
    • The before method is called during the execution of a variation method before the flag value has been determined. The method is executed synchronously.

      Parameters

      • hookContext: EvaluationSeriesContext

        Contains information about the evaluation being performed. This is not mutable.

      • data: EvaluationSeriesData

        A record associated with each stage of hook invocations. Each stage is called with the data of the previous stage for a series. The input record should not be modified.

      Returns EvaluationSeriesData

      Data to use when executing the next state of the hook in the evaluation series. It is recommended to expand the previous input into the return. This helps ensure your stage remains compatible moving forward as more stages are added.

      return {...data, "my-new-field": /*my data/*}