Function useSignal

useSignal(initial?: boolean, signalCallback?: Dispatch<boolean>, resetCallback?: Dispatch<boolean>): [boolean, (() => void), (() => void)]
This is like useState<boolean> but provides explicit methods to set the value. This either sets it to true or the initial state. If the intial state is true then this will always be true.

Returns
an array containing the signal value, a setter callback and a reset back to initial value callback
Parameters
- initial: boolean = false
- signalCallback: Dispatch<boolean> = noop
- resetCallback: Dispatch<boolean> = noop
Returns [boolean, (() => void), (() => void)]
- Defined in src/useStates/useSignal.ts:9