Skip to content

Core data: Fix some typing issues #39212

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
dmsnell merged 2 commits into from
Mar 4, 2022
Merged

Core data: Fix some typing issues #39212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b37b101
Core data: Fix some typing issues
dmsnell Mar 4, 2022
147ecfa
Update packages/core-data/src/actions.js
adamziel Mar 4, 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
10 changes: 1 addition & 9 deletions docs/reference-guides/data/data-core.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@ _Parameters_
- _recordId_ `number`: Record ID of the edited entity record.
- _edits_ `Object`: The edits.
- _options_ `Object`: Options for the edit.
- _options.undoIgnore_ `boolean`: Whether to ignore the edit in undo history or not.
- _options.undoIgnore_ `[boolean]`: Whether to ignore the edit in undo history or not.

_Returns_

Expand Down Expand Up @@ -680,10 +680,6 @@ _Returns_
Action triggered to redo the last undoed
edit to an entity record, if any.

_Returns_

- `undefined`:

### saveEditedEntityRecord

Action triggered to save an entity record's edits.
Expand Down Expand Up @@ -713,8 +709,4 @@ _Parameters_
Action triggered to undo the last edit to
an entity record, if any.

_Returns_

- `undefined`:

<!-- END TOKEN(Autogenerated actions|../../../packages/core-data/src/actions.js) -->
10 changes: 1 addition & 9 deletions packages/core-data/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ _Parameters_
- _recordId_ `number`: Record ID of the edited entity record.
- _edits_ `Object`: The edits.
- _options_ `Object`: Options for the edit.
- _options.undoIgnore_ `boolean`: Whether to ignore the edit in undo history or not.
- _options.undoIgnore_ `[boolean]`: Whether to ignore the edit in undo history or not.

_Returns_

Expand Down Expand Up @@ -214,10 +214,6 @@ _Returns_
Action triggered to redo the last undoed
edit to an entity record, if any.

_Returns_

- `undefined`:

### saveEditedEntityRecord

Action triggered to save an entity record's edits.
Expand Down Expand Up @@ -247,10 +243,6 @@ _Parameters_
Action triggered to undo the last edit to
an entity record, if any.

_Returns_

- `undefined`:

<!-- END TOKEN(Autogenerated actions|src/actions.js) -->

## Selectors
Expand Down
20 changes: 8 additions & 12 deletions packages/core-data/src/actions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,12 +283,12 @@ export const deleteEntityRecord = (
* Returns an action object that triggers an
* edit to an entity record.
*
* @param {string} kind Kind of the edited entity record.
* @param {string} name Name of the edited entity record.
* @param {number} recordId Record ID of the edited entity record.
* @param {Object} edits The edits.
* @param {Object} options Options for the edit.
* @param {boolean} options.undoIgnore Whether to ignore the edit in undo history or not.
* @param {string} kind Kind of the edited entity record.
* @param {string} name Name of the edited entity record.
* @param {number} recordId Record ID of the edited entity record.
* @param {Object} edits The edits.
* @param {Object} options Options for the edit.
* @param {boolean} [options.undoIgnore] Whether to ignore the edit in undo history or not.
*
* @return {Object} Action object.
*/
Expand Down Expand Up @@ -345,8 +345,6 @@ export const editEntityRecord = (
/**
* Action triggered to undo the last edit to
* an entity record, if any.
*
* @return {undefined}
*/
export const undo = () => ( { select, dispatch } ) => {
const undoEdit = select.getUndoEdit();
Expand All @@ -363,8 +361,6 @@ export const undo = () => ( { select, dispatch } ) => {
/**
* Action triggered to redo the last undoed
* edit to an entity record, if any.
*
* @return {undefined}
*/
export const redo = () => ( { select, dispatch } ) => {
const redoEdit = select.getRedoEdit();
Expand Down Expand Up @@ -607,8 +603,8 @@ export const saveEntityRecord = (
* `saveEntityRecord`, `saveEditedEntityRecord`, and
* `deleteEntityRecord`.
*
* @return {Promise} A promise that resolves to an array containing the return
* values of each function given in `requests`.
* @return {(thunkArgs: Object) => Promise} A promise that resolves to an array containing the return
* values of each function given in `requests`.
*/
export const __experimentalBatch = ( requests ) => async ( { dispatch } ) => {
const batch = createBatch();
Expand Down