Compass/web/hooks/use-state-check-equality.ts

import {isEqual} from 'lodash'
import {SetStateAction, useMemo, useRef, useState} from 'react'

export const useStateCheckEquality = <T>(initialState: T) => {
  const [state, setState] = useState(initialState)

  const stateRef = useRef(state)
  stateRef.current = state

  const checkSetState = useMemo(
    () => (next: SetStateAction<T>) => {
      const state = stateRef.current
      const newState = next instanceof Function ? next(state) : next
      if (!isEqual(state, newState)) {
        setState(newState)
      }
    },
    [stateRef],
  )

  return [state, checkSetState] as const
}