Use EntityQuery type in getEntityRecord type signature

WordPress · Mar 14, 2022 · 27db5ca · 27db5ca
1 parent 8964cb0
commit 27db5ca
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 11 deletions.
diff --git a/packages/core-data/src/entity-types/entities.ts b/packages/core-data/src/entity-types/entities.ts
@@ -36,13 +36,16 @@ export interface EntityDeclaration {
 /**
  * HTTP Query parameters sent with the API request to fetch the entity records.
  */
-type EntityQuery< C extends Context > = Record< string, any > & {
+export type EntityQuery<
+	C extends Context,
+	Fields extends string[] | undefined = undefined
+> = Record< string, any > & {
 	context?: C;
 	/**
 	 * The requested fields. If specified, the REST API will remove from the response
 	 * any fields not on that list.
 	 */
-	_fields?: string[];
+	_fields?: Fields;
 };
 
 /**

diff --git a/packages/core-data/src/entity-types/selectors.ts b/packages/core-data/src/entity-types/selectors.ts
@@ -1,11 +1,19 @@
 /**
  * Internal dependencies
  */
-import type { Context, Theme, Updatable, User, WpTemplate } from './index';
+import type {
+	Context,
+	Theme,
+	Updatable,
+	User,
+	WpTemplate,
+	Comment,
+} from './index';
 import type {
 	DefaultContextOf,
 	EntityDeclaration,
 	EntityOf,
+	EntityQuery,
 	KeyOf,
 	Kind,
 	KindOf,
@@ -56,10 +64,7 @@ export type getEntityRecord = <
 	kind: K,
 	name: N,
 	key: KeyOf< R >,
-	query?: {
-		context?: C;
-		_fields?: Fields;
-	}
+	query?: EntityQuery< C, Fields >
 ) =>
 	| ( Fields extends undefined
 			? RecordOf< K, N, C >
@@ -99,10 +104,7 @@ export type getEntityRecords = <
 	state: State,
 	kind: K,
 	name: N,
-	query?: {
-		context?: C;
-		_fields?: Fields;
-	}
+	query?: EntityQuery< C, Fields >
 ) =>
 	| Array<
 			Fields extends undefined