Function useLogEventOnce

packages/shared/src/hooks/log/useLogEventOnce.ts:40–58

(
  getEvent: () => LogEvent,
  options?: UseLogEventOnceOptions,
)

 * );
 */
const useLogEventOnce = (
  getEvent: () => LogEvent,
  options?: UseLogEventOnceOptions,
): void => {
  const { logEvent } = useLogContext();
  const hasLoggedRef = useRef(false);
  const getEventRef = useRef(getEvent);

  getEventRef.current = getEvent;

  const { condition = true } = options ?? {};

  useEffect(() => {
    if (condition && !hasLoggedRef.current) {
      hasLoggedRef.current = true;
      logEvent(getEventRef.current());
    }
  }, [condition, logEvent]);
};

export default useLogEventOnce;