All files / modules/10-common/hooks useGlobalEventListener.ts

100% Statements 12/12
50% Branches 1/2
100% Functions 5/5
100% Lines 12/12

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37              1077x       1077x         278x   278x 275x     278x 275x 158x 158x       275x   275x 245x        
/*
 * Copyright 2021 Harness Inc. All rights reserved.
 * Use of this source code is governed by the PolyForm Shield 1.0.0 license
 * that can be found in the licenses directory at the root of this repository, also available at
 * https://polyformproject.org/wp-content/uploads/2020/06/PolyForm-Shield-1.0.0.txt.
 */
 
import { useEffect, useRef } from 'react'
 
export type EventHandler<K extends keyof WindowEventMap> = (ev: WindowEventMap[K]) => void
 
export function useGlobalEventListener<K extends keyof WindowEventMap>(
  type: K,
  handler: EventHandler<K>,
  options?: AddEventListenerOptions
): void {
  const savedHandler = useRef<EventHandler<K> | undefined>()
 
  useEffect(() => {
    savedHandler.current = handler
  }, [handler])
 
  useEffect(() => {
    const eventListener = (event: WindowEventMap[K]): void => {
      Eif (typeof savedHandler.current === 'function') {
        savedHandler.current(event)
      }
    }
 
    window.addEventListener(type, eventListener, options)
 
    return (): void => {
      window.removeEventListener(type, eventListener, options)
    }
  })
}