fix: typings

open-craft · Oct 25, 2023 · 069b07c · 069b07c
1 parent 2809d91
commit 069b07c
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 9 deletions.
diff --git a/src/taxonomy/api/hooks/api.js b/src/taxonomy/api/hooks/api.js
@@ -48,7 +48,7 @@ export const useTaxonomyDetailData = (taxonomyId) => (
 
 /**
  * @param {number} taxonomyId
- * @param {number} options
+ * @param {import('../types.mjs').QueryOptions} options
  * @returns {import('@tanstack/react-query').UseQueryResult<import('../types.mjs').TaxonomyData>}
  */
 export const useTagListData = (taxonomyId, options) => {

diff --git a/src/taxonomy/api/hooks/selectors.js b/src/taxonomy/api/hooks/selectors.js
@@ -63,12 +63,7 @@ export const useTaxonomyDetailDataResponse = (taxonomyId) => {
 /**
  * @param {number} taxonomyId
  * @param {import("../types.mjs").QueryOptions} options
- * @returns {
-   * Pick<
-     * import('@tanstack/react-query').UseQueryResult,
-     * "error" | "isError" | "isFetched" | "isLoading" | "isSuccess"
-   * >
- * }
+ * @returns {Pick<import('@tanstack/react-query').UseQueryResult, "error" | "isError" | "isFetched" | "isLoading" | "isSuccess" >}
  */
 export const useTagListDataStatus = (taxonomyId, options) => {
   const {

diff --git a/src/taxonomy/api/types.mjs b/src/taxonomy/api/types.mjs
@@ -1,6 +1,6 @@
 // @ts-check
 
-/** 
+/**
  * @typedef {Object} TaxonomyData
  * @property {number} id
  * @property {string} name
@@ -42,5 +42,5 @@
 
 /**
  * @typedef {Object} QueryOptions
- * @property {number} page_index
+ * @property {number} pageIndex
  */