@coveo/headless-react
    Preparing search index...

    Interface ExecuteTrigger

    The ExecuteTrigger controller handles Execute triggers from the query response. An Execute trigger query pipeline rule lets you define a custom JavaScript function to be executed in the frontend when a certain condition is met.

    Examples:

    interface ExecuteTrigger {
        state: ExecuteTriggerState;
        subscribe(listener: () => void): Unsubscribe;
    }

    Hierarchy (View Summary)

    Index

    Methods

    Properties

    Methods

    • Adds a callback that's invoked on state change.

      Parameters

      • listener: () => void

        A callback that's invoked on state change.

      Returns Unsubscribe

      A function to remove the listener.

    Properties

    The state of the ExecuteTrigger controller.