Skip to content

[@wordpress/data] Fix return value of dispatched actions to be a Promise #60693

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
typescript-bot merged 10 commits into from
Jun 20, 2022
Merged

[@wordpress/data] Fix return value of dispatched actions to be a Promise #60693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2a8bb8f
Change return type of dispatched action to a Promise
sirbrillig Jun 6, 2022
d491fd7
Add tests for dispatched action return type
sirbrillig Jun 6, 2022
e4798c4
Remove redundant test
sirbrillig Jun 6, 2022
ec22e43
Satisfy TS 4.1 types
sirbrillig Jun 6, 2022
ba75bc9
Make the change non-breaking
sirbrillig Jun 6, 2022
90cb014
Adjust test for TS 4.1 again
sirbrillig Jun 6, 2022
e4199c1
Fix missing semi
sirbrillig Jun 6, 2022
6e6d5d2
Allow for non-promises
sirbrillig Jun 7, 2022
6353f1f
Fix test expectation for TS 4.1
sirbrillig Jun 7, 2022
66189e9
Add test for non-promise
sirbrillig Jun 8, 2022
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
3 changes: 2 additions & 1 deletion types/wordpress__data/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ export { Action, combineReducers };
//
export type ResolveSelectorMap = Record<string, <T = unknown>(...args: readonly any[]) => Promise<T>>;
export type SelectorMap = Record<string, <T = unknown>(...args: readonly any[]) => T>;
export type DispatcherMap = Record<string, <T = void>(...args: readonly any[]) => T>;
type EnsurePromise<T> = T extends Promise<any> ? T : Promise<T>;
export type DispatcherMap = Record<string, <T = void, DoEnsurePromise extends boolean = true>(...args: readonly any[]) => DoEnsurePromise extends true ? EnsurePromise<T> : T>;

/**
* Subscribe to any changes to the store
Expand Down
12 changes: 9 additions & 3 deletions types/wordpress__data/wordpress__data-tests.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,21 @@ const HookComponent = () => {
// `dispatch` overload tests
//

// $ExpectType Record<string, <T = void>(...args: readonly any[]) => T> || DispatcherMap
// $ExpectType Record<string, <T = void, DoEnsurePromise extends boolean = true>(...args: readonly any[]) => DoEnsurePromise extends true ? EnsurePromise<T> : T> || DispatcherMap
data.dispatch('foo/bar');

// $ExpectType void
// $ExpectType Promise<void>
data.dispatch('foo/bar').foobar();

// $ExpectType number
// $ExpectType Promise<number>
data.dispatch('foo/bar').foobar<Promise<number>>();

// $ExpectType Promise<number>
data.dispatch('foo/bar').foobar<number>();

// $ExpectType number
data.dispatch('foo/bar').foobar<number, false>();

// $ExpectType Record<string, <T = unknown>(...args: readonly any[]) => T> || SelectorMap
data.select('foo/bar');

Expand Down