mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-11 20:27:12 +01:00
3732c5f71e
ESLint rules have been added to enforce our JSDoc conventions. These rules were introduced by updating `@metamask/eslint-config` to v9. Some of the rules have been disabled because the effort to fix all lint errors was too high. It might be easiest to enable these rules one directory at a time, or one rule at a time. Most of the changes in this PR were a result of running `yarn lint:fix`. There were a handful of manual changes that seemed obvious and simple to make. Anything beyond that and the rule was left disabled.
41 lines
1.4 KiB
JavaScript
41 lines
1.4 KiB
JavaScript
import { useContext, useCallback } from 'react';
|
|
import { MetaMetricsContext } from '../contexts/metametrics';
|
|
import { MetaMetricsContext as NewMetaMetricsContext } from '../contexts/metametrics.new';
|
|
import { useEqualityCheck } from './useEqualityCheck';
|
|
|
|
// Type imports
|
|
/**
|
|
* @typedef {import('../contexts/metametrics.new').UIMetricsEventPayload} UIMetricsEventPayload
|
|
* @typedef {import('../../shared/constants/metametrics').MetaMetricsEventOptions} MetaMetricsEventOptions
|
|
*/
|
|
|
|
export function useMetricEvent(config = {}, overrides = {}) {
|
|
const metricsEvent = useContext(MetaMetricsContext);
|
|
const trackEvent = useCallback(() => metricsEvent(config, overrides), [
|
|
config,
|
|
metricsEvent,
|
|
overrides,
|
|
]);
|
|
return trackEvent;
|
|
}
|
|
|
|
/**
|
|
* track a metametrics event using segment
|
|
* e.g metricsEvent({ event: 'Unlocked MetaMask', category: 'Navigation' })
|
|
*
|
|
* @param {UIMetricsEventPayload} payload - payload of the event to track
|
|
* @param {MetaMetricsEventOptions} options - options for handling/routing event
|
|
* @returns {() => Promise<void>} function to execute the tracking event
|
|
*/
|
|
export function useNewMetricEvent(payload, options) {
|
|
const memoizedPayload = useEqualityCheck(payload);
|
|
const memoizedOptions = useEqualityCheck(options);
|
|
const metricsEvent = useContext(NewMetaMetricsContext);
|
|
|
|
return useCallback(() => metricsEvent(memoizedPayload, memoizedOptions), [
|
|
metricsEvent,
|
|
memoizedPayload,
|
|
memoizedOptions,
|
|
]);
|
|
}
|