Skip to content

Search Streams

Triggers when the search requests results.

import { searchRequesting$ } from '@shopgate/engage/search';
subscribe(searchRequesting$, ({ action, dispatch, getState, prevState, events }) => {
// The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { searchRequesting$ } from '@shopgate/pwa-common-commerce/search'


Triggers when the search receives results.

import { searchReceived$ } from '@shopgate/engage/search';
subscribe(searchReceived$, ({ action, dispatch, getState, prevState, events }) => {
// The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { searchReceived$ } from '@shopgate/pwa-common-commerce/search'


Triggers when the search route prepares to enter.

import { searchWillEnter$ } from '@shopgate/engage/search';
subscribe(searchWillEnter$, ({ action, dispatch, getState, prevState, events }) => {
// The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { searchWillEnter$ } from '@shopgate/pwa-common-commerce/search'


Triggers when the search route enters.

import { searchDidEnter$ } from '@shopgate/engage/search';
subscribe(searchDidEnter$, ({ action, dispatch, getState, prevState, events }) => {
// The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { searchDidEnter$ } from '@shopgate/pwa-common-commerce/search'


Triggers when the search route prepares to leave.

import { searchWillLeave$ } from '@shopgate/engage/search';
subscribe(searchWillLeave$, ({ action, dispatch, getState, prevState, events }) => {
// The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { searchWillLeave$ } from '@shopgate/pwa-common-commerce/search'


Triggers when the search route prepares to update.

import { searchWillUpdate$ } from '@shopgate/engage/search';
subscribe(searchWillUpdate$, ({ action, dispatch, getState, prevState, events }) => {
// The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { searchWillUpdate$ } from '@shopgate/pwa-common-commerce/search'