trackFailureEvent

Triggers an FailureEvent.

trackFailureEvent = (parameters: {
  message: string;
  element?: TrackedElement;
  locationStack?: LocationStack;
  globalContexts?: GlobalContexts;
  tracker?: BrowserTracker;
  onError?: TrackerErrorHandlerCallback;  
}) => void

Parameters

		type	default value
optional	element	TrackedElement	document
optional	locationStack	LocationStack
optional	globalContexts	GlobalContexts
optional	tracker	BrowserTracker
optional	onError	TrackerErrorHandlerCallback	TrackerConsole.error

Returns

trackFailureEvent is a void function.

Usage example

import { trackFailurEvent, trackSuccessEvent } from '@objectiv/tracker-browser';

<form onSubmit={() => {
  sendFormAsync()
    .then(
      () => trackSuccessEvent({ message: 'Yes!', element: form }), 
      () => trackFailureEvent({ message: 'Remote rejection.', element: form })
    )
    .catch(
      () => trackFailureEvent({ message: 'Network failure.', element: form })
    );
}}>
  ...
</form>

tip

trackFailureEvent can be safely used while network is temporarily down. Events will be queued and sending will be retried.

Did you know ?

trackFailureEvent is just syntactic sugar on top of trackEvent.

See also

• makeTracker
• trackEvent