Add function overloads

WordPress · Jul 24, 2024 · 92339b8 · 92339b8
1 parent 9594d4f
commit 92339b8
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/packages/core-data/README.md b/packages/core-data/README.md
@@ -1230,7 +1230,7 @@ the store state using `canUser()`, or resolved if missing.
 _Parameters_
 
 -   _resource_ `string | EntityResource`: Entity resource to check. Accepts entity object `{ kind: 'root', name: 'media', id: 1 }` or REST base as a string - `media`.
--   _id_ `IdType`: Optional ID of the rest resource to check. e.g. 10.
+-   _id_ `IdType`: Optional ID of the resource to check, e.g. 10. Note: The argument will be ignored when using an entity object as a resource to check permissions.
 
 _Returns_
 

diff --git a/packages/core-data/src/hooks/use-resource-permissions.ts b/packages/core-data/src/hooks/use-resource-permissions.ts
@@ -43,14 +43,25 @@ type ResourcePermissionsResolution< IdType > = [
 
 type EntityResource = { kind: string; name: string; id?: string | number };
 
+function useResourcePermissions< IdType = void >(
+	resource: string,
+	id?: IdType
+): ResourcePermissionsResolution< IdType >;
+
+function useResourcePermissions< IdType = void >(
+	resource: EntityResource,
+	id?: never
+): ResourcePermissionsResolution< IdType >;
+
 /**
  * Resolves resource permissions.
  *
  * @since 6.1.0 Introduced in WordPress core.
  *
  * @param    resource Entity resource to check. Accepts entity object `{ kind: 'root', name: 'media', id: 1 }`
  *                    or REST base as a string - `media`.
- * @param    id       Optional ID of the rest resource to check. e.g. 10.
+ * @param    id       Optional ID of the resource to check, e.g. 10. Note: The argument will be ignored
+ *                    when using an entity object as a resource to check permissions.
  *
  * @example
  * ```js
@@ -112,7 +123,7 @@ type EntityResource = { kind: string; name: string; id?: string | number };
  * @return Entity records data.
  * @template IdType
  */
-export default function useResourcePermissions< IdType = void >(
+function useResourcePermissions< IdType = void >(
 	resource: string | EntityResource,
 	id?: IdType
 ): ResourcePermissionsResolution< IdType > {
@@ -190,6 +201,8 @@ export default function useResourcePermissions< IdType = void >(
 	);
 }
 
+export default useResourcePermissions;
+
 export function __experimentalUseResourcePermissions(
 	resource: string,
 	id?: unknown