Skip to content

Promisify action creator return type for WP data dispatch #52530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
noahtallen merged 11 commits into from
Jul 20, 2023
Merged

Promisify action creator return type for WP data dispatch #52530

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
5162962
Promisify action creators in ActionCreatorsOf type
noahtallen Jul 11, 2023
943ff9c
Add singular and plural helper types
noahtallen Jul 12, 2023
3046bf7
Add returntype for promisified action creators
noahtallen Jul 12, 2023
a9aad26
Add changelog entry
noahtallen Jul 12, 2023
9566b70
Update plain dispatch to handle string store descriptor
noahtallen Jul 13, 2023
006048e
Update PromisifiedActionCreator to handle thunks
noahtallen Jul 13, 2023
e08fd01
Update generated docs
noahtallen Jul 13, 2023
de0aeae
Clarify comments
noahtallen Jul 13, 2023
1b9b7ad
Account for async thunks
noahtallen Jul 13, 2023
cc4ca6a
Update changelog
noahtallen Jul 13, 2023
8cbdc88
Make comment less redundant
noahtallen Jul 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update PromisifiedActionCreator to handle thunks
  • Loading branch information
@noahtallen
noahtallen committed Jul 20, 2023
commit 006048efbb98a497c5f62a985f3ab1477cfa1745
18 changes: 14 additions & 4 deletions packages/data/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,15 @@ export interface ReduxStoreConfig<
controls?: MapOf< Function >;
}

// Return type for the useSelect() hook.
export type UseSelectReturn< F extends MapSelect | StoreDescriptor< any > > =
F extends MapSelect
? ReturnType< F >
: F extends StoreDescriptor< any >
? CurriedSelectorsOf< F >
: never;

// Return type for the useDispatch() hook.
export type UseDispatchReturn< StoreNameOrDescriptor > =
StoreNameOrDescriptor extends StoreDescriptor< any >
? ActionCreatorsOf< ConfigOf< StoreNameOrDescriptor > >
Expand All @@ -59,9 +61,12 @@ export type UseDispatchReturn< StoreNameOrDescriptor > =

export type DispatchFunction = < StoreNameOrDescriptor >(
store: StoreNameOrDescriptor
) => StoreNameOrDescriptor extends StoreDescriptor< any >
? ActionCreatorsOf< ConfigOf< StoreNameOrDescriptor > >
: any;
) => DispatchReturn< StoreNameOrDescriptor >;

export type DispatchReturn< StoreNameOrDescriptor > =
StoreNameOrDescriptor extends StoreDescriptor< any >
? ActionCreatorsOf< ConfigOf< StoreNameOrDescriptor > >
: unknown;

export type MapSelect = (
select: SelectFunction,
Expand Down Expand Up @@ -185,7 +190,12 @@ export type PromisifiedActionCreators<
// creator, so that consumers know that they are dealing with a Promise.
export type PromisifyActionCreator< Action extends ActionCreator > = (
...args: Parameters< Action >
) => Promise< ReturnType< Action > >;
) => Promise<
ReturnType< Action > extends ( ..._args: any[] ) => any
? // Thunks return another function, so we unwrap the return type twice in that scenario.
ReturnType< ReturnType< Action > >
: ReturnType< Action >
>;

type SelectorsOf< Config extends AnyConfig > = Config extends ReduxStoreConfig<
any,
Expand Down