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
Next Next commit
Promisify action creators in ActionCreatorsOf type
  • Loading branch information
@noahtallen
noahtallen committed Jul 20, 2023
commit 5162962a5c1f7f17c4f2f19d2bda051353839a60
12 changes: 10 additions & 2 deletions packages/data/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import type { combineReducers as reduxCombineReducers } from 'redux';

type MapOf< T > = { [ name: string ]: T };

export type ActionCreator = Function | Generator;
export type ActionCreator = ( ...args: any[] ) => any | Generator;
Copy link
Member Author

@noahtallen noahtallen Jul 11, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Function doesn't let you add return types and isn't compatible with the arrow syntax, so it needs to be changed so that we can wrap around the type below.

export type Resolver = Function | Generator;
export type Selector = Function;

Expand Down Expand Up @@ -170,9 +170,17 @@ export type ConfigOf< S > = S extends StoreDescriptor< infer C > ? C : never;

export type ActionCreatorsOf< Config extends AnyConfig > =
Config extends ReduxStoreConfig< any, infer ActionCreators, any >
? ActionCreators
? PromisifiedActionCreator< ActionCreators >
: never;

// When dispatching an action creator, the return value is a promise.
type PromisifiedActionCreator< ActionCreators extends MapOf< ActionCreator > > =
{
[ Action in keyof ActionCreators ]: (
...args: Parameters< ActionCreators[ Action ] >
) => Promise< void >;
};

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