Class EventStream

on

• on<T>(eventType: T, callback: (event: Extract<ResetStateEvent, { type: T }> | Extract<NewSearchEvent, { type: T }> | Extract<FacetValueChangedEvent, { type: T }> | Extract<FetchFacetOptionsPendingEvent, { type: T }> | Extract<FetchFacetOptionsSuccessEvent, { type: T }> | Extract<FetchFacetOptionsErrorEvent, { type: T }> | Extract<FetchResultsPendingEvent, { type: T }> | Extract<FetchResultsSuccessEvent, { type: T }> | Extract<FetchResultsErrorEvent, { type: T }>) => void): void

• Used for subscribing to events. Note that events from all facets will be subscribed. If you want to act on events from only one facet you have to check if event.facetId === facet.id in callback.

  Type parameters

  • T: "RESET_STATE" | "NEW_SEARCH" | "FACET_VALUE_CHANGED" | "FETCH_FACET_OPTIONS_PENDING" | "FETCH_FACET_OPTIONS_SUCCESS" | "FETCH_FACET_OPTIONS_ERROR" | "FETCH_RESULTS_PENDING" | "FETCH_RESULTS_SUCCESS" | "FETCH_RESULTS_ERROR"

  Parameters

  • eventType: T

    event type to subscribe

  • callback: (event: Extract<ResetStateEvent, { type: T }> | Extract<NewSearchEvent, { type: T }> | Extract<FacetValueChangedEvent, { type: T }> | Extract<FetchFacetOptionsPendingEvent, { type: T }> | Extract<FetchFacetOptionsSuccessEvent, { type: T }> | Extract<FetchFacetOptionsErrorEvent, { type: T }> | Extract<FetchResultsPendingEvent, { type: T }> | Extract<FetchResultsSuccessEvent, { type: T }> | Extract<FetchResultsErrorEvent, { type: T }>) => void

    • • (event: Extract<ResetStateEvent, { type: T }> | Extract<NewSearchEvent, { type: T }> | Extract<FacetValueChangedEvent, { type: T }> | Extract<FetchFacetOptionsPendingEvent, { type: T }> | Extract<FetchFacetOptionsSuccessEvent, { type: T }> | Extract<FetchFacetOptionsErrorEvent, { type: T }> | Extract<FetchResultsPendingEvent, { type: T }> | Extract<FetchResultsSuccessEvent, { type: T }> | Extract<FetchResultsErrorEvent, { type: T }>): void

      • Parameters

        • event: Extract<ResetStateEvent, { type: T }> | Extract<NewSearchEvent, { type: T }> | Extract<FacetValueChangedEvent, { type: T }> | Extract<FetchFacetOptionsPendingEvent, { type: T }> | Extract<FetchFacetOptionsSuccessEvent, { type: T }> | Extract<FetchFacetOptionsErrorEvent, { type: T }> | Extract<FetchResultsPendingEvent, { type: T }> | Extract<FetchResultsSuccessEvent, { type: T }> | Extract<FetchResultsErrorEvent, { type: T }>

        Returns void

  Returns void