[use-global-hook] add setState overload for immer

[no-stack-dub-sack]

Discussed in #57264

^{Originally posted by no-stack-dub-sack November 18, 2021}
When using immer, the setState function accepts a set state callback as the first argument. The current types do not support this:

export interface Store<S, A> {
    state: S;
    actions: A;
    setState(state: S, afterUpdateCallback?: () => void): void;
}

I propose adding an overload to setState so that this code will compile when using the Immer plugin.

The new overload could look like this:

export interface Store<S, A> {
    state: S;
    actions: A;
    setState(state: S, afterUpdateCallback?: () => void): void;
    setState(immerSetState: (state: S) => void): void;
}

Though I'm not sure the best way to do this because the overload will still be available when not using Immer and using it would cause a runtime error. Perhaps there's a better way to do this other than just adding an overload that's always present. Maybe something like this:

export type Store<S, A, WithImmer extends boolean = false> = WithImmer extends false ? {
    state: S;
    actions: A;
    setState(state: S, afterUpdateCallback?: () => void): void;
} : {
    state: S;
    actions: A;
    setState(immerSetState: (state: S) => void): void;
}

Thoughts?

[no-stack-dub-sack]

closing after reading Moving DT issues to Discussions