use-reset-state

1import { isFunction } from 'es-toolkit/predicate'
2import { useRef, useState } from 'react'
3import { useCreation } from '@/registry/hooks/use-creation'
4import { useMemoizedFn } from '@/registry/hooks/use-memoized-fn'
5import type { Dispatch, SetStateAction } from 'react'
6 
7type ResetState = () => void
8 
9export function useResetState<S>(
10  initialState: S | (() => S),
11): readonly [S, Dispatch<SetStateAction<S>>, ResetState] {
12  const initialStateRef = useRef(initialState)
13  const initialStateMemo = useCreation(
14    () =>
15      isFunction(initialStateRef.current)
16        ? initialStateRef.current()
17        : initialStateRef.current,
18    [],
19  )
20 
21  const [state, setState] = useState(initialStateMemo)
22 
23  const resetState = useMemoizedFn(() => {
24    setState(initialStateMemo)
25  })
26 
27  return [state, setState, resetState]
28}