Document useEntityRecord/s in README.md and CHANGELOG.md #40932
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adamziel
added
[Type] Developer Documentation
adamziel
commented
May 9, 2022
adamziel
commented
May 9, 2022
gziolo
reviewed
May 9, 2022
gziolo
reviewed
May 9, 2022
Co-authored-by: Greg Ziółkowski <[email protected]>
…ress/gutenberg into update/document-use-entity-records
|
Size Change: +783 B (0%) Total Size: 1.24 MB
ℹ️ View Unchanged
|
Member
|
I tried the following changes locally: diff --git a/packages/core-data/src/hooks/index.ts b/packages/core-data/src/hooks/index.ts
index bdd1ad8adc..ea1aa1c49c 100644
--- a/packages/core-data/src/hooks/index.ts
+++ b/packages/core-data/src/hooks/index.ts
@@ -1,8 +1,8 @@
export {
- useEntityRecord,
+ default as useEntityRecord,
__experimentalUseEntityRecord,
} from './use-entity-record';
export {
- useEntityRecords,
+ default as useEntityRecords,
__experimentalUseEntityRecords,
} from './use-entity-records';
diff --git a/packages/core-data/src/hooks/use-entity-record.ts b/packages/core-data/src/hooks/use-entity-record.ts
index 3c749b97dc..eb96cbfab2 100644
--- a/packages/core-data/src/hooks/use-entity-record.ts
+++ b/packages/core-data/src/hooks/use-entity-record.ts
@@ -70,7 +70,7 @@ export interface Options {
* @return Entity record data.
* @template RecordType
*/
-export function useEntityRecord< RecordType >(
+export default function useEntityRecord< RecordType >(
kind: string,
name: string,
recordId: string | number,
@@ -92,8 +92,6 @@ export function useEntityRecord< RecordType >(
};
}
-export default useEntityRecord;
-
export function __experimentalUseEntityRecord(
kind: string,
name: string,
diff --git a/packages/core-data/src/hooks/use-entity-records.ts b/packages/core-data/src/hooks/use-entity-records.ts
index 2d51f778cb..2dbc83bf66 100644
--- a/packages/core-data/src/hooks/use-entity-records.ts
+++ b/packages/core-data/src/hooks/use-entity-records.ts
@@ -59,7 +59,7 @@ const EMPTY_ARRAY = [];
* @return Entity records data.
* @template RecordType
*/
-export function useEntityRecords< RecordType >(
+export default function useEntityRecords< RecordType >(
kind: string,
name: string,
queryArgs: Record< string, unknown > = {},
@@ -90,8 +90,6 @@ export function useEntityRecords< RecordType >(
};
}
-export default useEntityRecords;
-
export function __experimentalUseEntityRecords(
kind: string,
name: string,
diff --git a/packages/core-data/src/index.js b/packages/core-data/src/index.js
index d99d591858..05cace07c9 100644
--- a/packages/core-data/src/index.js
+++ b/packages/core-data/src/index.js
@@ -68,12 +68,7 @@ export const store = createReduxStore( STORE_NAME, storeConfig() );
register( store );
export { default as EntityProvider } from './entity-provider';
-export {
- useEntityRecord,
- __experimentalUseEntityRecord,
- useEntityRecords,
- __experimentalUseEntityRecords,
-} from './hooks';
export * from './entity-provider';
-export * from './fetch';
export * from './entity-types';
+export * from './fetch';
+export * from './hooks';It seems to work correctly and resolves the issue you encountered in #40932 (comment). |
gziolo
approved these changes
May 10, 2022
Member
gziolo
left a comment
gziolo
left a comment
There was a problem hiding this comment.
I re-triggered failing jobs that seemed unrelated to these changes. If they pass we should be good to go.
I also included a diff with potential changes to how the files are imported. We could benefit from some better guidelines how to handle that on the project level.
Thank you so much for improving the documentation ❤️
Contributor
Author
|
Great patch @gziolo, it did the trick! Let's wait for the CI and merge this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
As @gziolo noted in #40162 (comment):
This PR does just that
Testing Instructions