diff --git a/.changeset/chatty-socks-guess.md b/.changeset/chatty-socks-guess.md new file mode 100644 index 000000000..8cbb61971 --- /dev/null +++ b/.changeset/chatty-socks-guess.md @@ -0,0 +1,7 @@ +--- +'@suspensive/react-query-4': patch +'@suspensive/react-query-5': patch +'@suspensive/react': patch +--- + +docs(react-query, react): Update jsdoc link from `en/docs` to `docs` diff --git a/packages/react-query-4/src/PrefetchInfiniteQuery.tsx b/packages/react-query-4/src/PrefetchInfiniteQuery.tsx index 2e6bd2582..3ce7c61d8 100644 --- a/packages/react-query-4/src/PrefetchInfiniteQuery.tsx +++ b/packages/react-query-4/src/PrefetchInfiniteQuery.tsx @@ -3,7 +3,7 @@ import { usePrefetchInfiniteQuery } from './usePrefetchInfiniteQuery' /** * A component that allows you to use `usePrefetchInfiniteQuery` in JSX, avoiding the limitations of React hooks. - * @see {@link https://suspensive.org/en/docs/react-query/PrefetchInfiniteQuery Suspensive Docs} + * @see {@link https://suspensive.org/docs/react-query/PrefetchInfiniteQuery Suspensive Docs} * @example * ```tsx * diff --git a/packages/react-query-4/src/PrefetchQuery.tsx b/packages/react-query-4/src/PrefetchQuery.tsx index fc9562547..285ee3f5a 100644 --- a/packages/react-query-4/src/PrefetchQuery.tsx +++ b/packages/react-query-4/src/PrefetchQuery.tsx @@ -3,7 +3,7 @@ import { usePrefetchQuery } from './usePrefetchQuery' /** * A component that allows you to use usePrefetchQuery in JSX, avoiding the limitations of React hooks. - * @see {@link https://suspensive.org/en/docs/react-query/PrefetchQuery Suspensive Docs} + * @see {@link https://suspensive.org/docs/react-query/PrefetchQuery Suspensive Docs} * @example * ```tsx * diff --git a/packages/react-query-4/src/SuspenseInfiniteQuery.tsx b/packages/react-query-4/src/SuspenseInfiniteQuery.tsx index eac1fef58..b1a0288e1 100644 --- a/packages/react-query-4/src/SuspenseInfiniteQuery.tsx +++ b/packages/react-query-4/src/SuspenseInfiniteQuery.tsx @@ -9,7 +9,7 @@ import { /** * We provide these components to clearly express what causes suspense at the same depth. * `` serves to make `useSuspenseInfiniteQuery` easier to use in jsx. - * @see {@link https://suspensive.org/en/docs/react-query/SuspenseInfiniteQuery Suspensive Docs} + * @see {@link https://suspensive.org/docs/react-query/SuspenseInfiniteQuery Suspensive Docs} * @example * ```tsx * import { SuspenseInfiniteQuery } from '@suspensive/react-query' diff --git a/packages/react-query-4/src/SuspenseQueries.tsx b/packages/react-query-4/src/SuspenseQueries.tsx index fceadd991..4cea2fbd3 100644 --- a/packages/react-query-4/src/SuspenseQueries.tsx +++ b/packages/react-query-4/src/SuspenseQueries.tsx @@ -4,7 +4,7 @@ import { type SuspenseQueriesOptions, type SuspenseQueriesResults, useSuspenseQu /** * We provide these components to clearly express what causes suspense at the same depth. * `` serves to make `useSuspenseQueries` easier to use in jsx. - * @see {@link https://suspensive.org/en/docs/react-query/SuspenseQueries Suspensive Docs} + * @see {@link https://suspensive.org/docs/react-query/SuspenseQueries Suspensive Docs} * @example * ```tsx * import { SuspenseQueries } from '@suspensive/react-query' diff --git a/packages/react-query-4/src/SuspenseQuery.tsx b/packages/react-query-4/src/SuspenseQuery.tsx index f758d87a7..21e3f3257 100644 --- a/packages/react-query-4/src/SuspenseQuery.tsx +++ b/packages/react-query-4/src/SuspenseQuery.tsx @@ -5,7 +5,7 @@ import { type UseSuspenseQueryOptions, type UseSuspenseQueryResult, useSuspenseQ /** * We provide these components to clearly express what causes suspense at the same depth. * `` serves to make `useSuspenseQuery` easier to use in jsx. - * @see {@link https://suspensive.org/en/docs/react-query/SuspenseQuery Suspensive Docs} + * @see {@link https://suspensive.org/docs/react-query/SuspenseQuery Suspensive Docs} * @example * ```tsx * import { SuspenseQuery } from '@suspensive/react-query' diff --git a/packages/react-query-4/src/queryOptions.ts b/packages/react-query-4/src/queryOptions.ts index 15472e924..1d39a9ff5 100644 --- a/packages/react-query-4/src/queryOptions.ts +++ b/packages/react-query-4/src/queryOptions.ts @@ -59,7 +59,7 @@ export type UnSelectedQueryOptions< * Creates a reusable query options object that can be used across different query hooks. * Provides better type inference and easier query key management. * - * @see {@link https://suspensive.org/en/docs/react-query/queryOptions Suspensive Docs} + * @see {@link https://suspensive.org/docs/react-query/queryOptions Suspensive Docs} */ export function queryOptions< TQueryFnData = unknown, diff --git a/packages/react-query-4/src/usePrefetchInfiniteQuery.ts b/packages/react-query-4/src/usePrefetchInfiniteQuery.ts index 377f472b0..0703faae0 100644 --- a/packages/react-query-4/src/usePrefetchInfiniteQuery.ts +++ b/packages/react-query-4/src/usePrefetchInfiniteQuery.ts @@ -2,7 +2,7 @@ import { type FetchInfiniteQueryOptions, type QueryKey, useQueryClient } from '@ /** * The `usePrefetchInfiniteQuery` does not return anything, it should be used just to fire a prefetch during render, before a suspense boundary that wraps a component that uses `useSuspenseInfiniteQuery`. - * @see {@link https://suspensive.org/en/docs/react-query/usePrefetchInfiniteQuery Suspensive Docs} + * @see {@link https://suspensive.org/docs/react-query/usePrefetchInfiniteQuery Suspensive Docs} */ export function usePrefetchInfiniteQuery< TQueryFnData = unknown, diff --git a/packages/react-query-4/src/usePrefetchQuery.ts b/packages/react-query-4/src/usePrefetchQuery.ts index a3d156140..f62e4e3a1 100644 --- a/packages/react-query-4/src/usePrefetchQuery.ts +++ b/packages/react-query-4/src/usePrefetchQuery.ts @@ -2,7 +2,7 @@ import { type FetchQueryOptions, type QueryKey, useQueryClient } from '@tanstack /** * The `usePrefetchQuery` does not return anything, it should be used just to fire a prefetch during render, before a suspense boundary that wraps a component that uses `useSuspenseQuery`. - * @see {@link https://suspensive.org/en/docs/react-query/usePrefetchQuery Suspensive Docs} + * @see {@link https://suspensive.org/docs/react-query/usePrefetchQuery Suspensive Docs} */ export function usePrefetchQuery< TQueryFnData = unknown, diff --git a/packages/react-query-4/src/useSuspenseInfiniteQuery.ts b/packages/react-query-4/src/useSuspenseInfiniteQuery.ts index 3843f7e56..6c342a59f 100644 --- a/packages/react-query-4/src/useSuspenseInfiniteQuery.ts +++ b/packages/react-query-4/src/useSuspenseInfiniteQuery.ts @@ -28,7 +28,7 @@ export type UseSuspenseInfiniteQueryOptions< /** * This hook is wrapping `useInfiniteQuery` of `@tanstack/react-query` v4 with default suspense option. - * @see {@link https://suspensive.org/en/docs/react-query/useSuspenseInfiniteQuery Suspensive Docs} + * @see {@link https://suspensive.org/docs/react-query/useSuspenseInfiniteQuery Suspensive Docs} */ export function useSuspenseInfiniteQuery< TQueryFnData = unknown, diff --git a/packages/react-query-4/src/useSuspenseQueries.ts b/packages/react-query-4/src/useSuspenseQueries.ts index 660a2f2e5..d3216354e 100644 --- a/packages/react-query-4/src/useSuspenseQueries.ts +++ b/packages/react-query-4/src/useSuspenseQueries.ts @@ -111,7 +111,7 @@ export type SuspenseQueriesResults< /** * This hook is wrapping `useQueries` of `@tanstack/react-query` v4 with default suspense option. - * @see {@link https://suspensive.org/en/docs/react-query/useSuspenseQueries Suspensive Docs} + * @see {@link https://suspensive.org/docs/react-query/useSuspenseQueries Suspensive Docs} */ export function useSuspenseQueries({ queries, diff --git a/packages/react-query-4/src/useSuspenseQuery.ts b/packages/react-query-4/src/useSuspenseQuery.ts index e094b4d5e..cc2d8f6e8 100644 --- a/packages/react-query-4/src/useSuspenseQuery.ts +++ b/packages/react-query-4/src/useSuspenseQuery.ts @@ -19,7 +19,7 @@ export type UseSuspenseQueryOptions< /** * This hook is wrapping `useQuery` of `@tanstack/react-query` v4 with default suspense option. - * @see {@link https://suspensive.org/en/docs/react-query/useSuspenseQuery Suspensive Docs} + * @see {@link https://suspensive.org/docs/react-query/useSuspenseQuery Suspensive Docs} */ export function useSuspenseQuery< TQueryFnData = unknown, diff --git a/packages/react-query-5/src/PrefetchInfiniteQuery.tsx b/packages/react-query-5/src/PrefetchInfiniteQuery.tsx index 8026a6c46..f5da63ddb 100644 --- a/packages/react-query-5/src/PrefetchInfiniteQuery.tsx +++ b/packages/react-query-5/src/PrefetchInfiniteQuery.tsx @@ -7,7 +7,7 @@ import { /** * A component that allows you to use usePrefetchInfiniteQuery in JSX, avoiding the limitations of React hooks. - * @see {@link https://suspensive.org/en/docs/react-query/PrefetchInfiniteQuery Suspensive Docs} + * @see {@link https://suspensive.org/docs/react-query/PrefetchInfiniteQuery Suspensive Docs} * @example * ```tsx * diff --git a/packages/react-query-5/src/PrefetchQuery.tsx b/packages/react-query-5/src/PrefetchQuery.tsx index 1b32e2449..d736da225 100644 --- a/packages/react-query-5/src/PrefetchQuery.tsx +++ b/packages/react-query-5/src/PrefetchQuery.tsx @@ -2,7 +2,7 @@ import { type DefaultError, type FetchQueryOptions, type QueryKey, usePrefetchQu /** * A component that allows you to use usePrefetchQuery in JSX, avoiding the limitations of React hooks. - * @see {@link https://suspensive.org/en/docs/react-query/PrefetchQuery Suspensive Docs} + * @see {@link https://suspensive.org/docs/react-query/PrefetchQuery Suspensive Docs} * @example * ```tsx * diff --git a/packages/react-query-5/src/SuspenseInfiniteQuery.tsx b/packages/react-query-5/src/SuspenseInfiniteQuery.tsx index 08a43a9b9..df7f83d7a 100644 --- a/packages/react-query-5/src/SuspenseInfiniteQuery.tsx +++ b/packages/react-query-5/src/SuspenseInfiniteQuery.tsx @@ -11,7 +11,7 @@ import type { ReactNode } from 'react' /** * We provide these components to clearly express what causes suspense at the same depth. * `` serves to make `useSuspenseInfiniteQuery` easier to use in jsx. - * @see {@link https://suspensive.org/en/docs/react-query/SuspenseInfiniteQuery Suspensive Docs} + * @see {@link https://suspensive.org/docs/react-query/SuspenseInfiniteQuery Suspensive Docs} * @example * ```tsx * import { SuspenseInfiniteQuery } from '@suspensive/react-query' diff --git a/packages/react-query-5/src/SuspenseQueries.tsx b/packages/react-query-5/src/SuspenseQueries.tsx index e5bfb2f04..10007df3c 100644 --- a/packages/react-query-5/src/SuspenseQueries.tsx +++ b/packages/react-query-5/src/SuspenseQueries.tsx @@ -4,7 +4,7 @@ import type { ReactNode } from 'react' /** * We provide these components to clearly express what causes suspense at the same depth. * `` serves to make `useSuspenseQueries` easier to use in jsx. - * @see {@link https://suspensive.org/en/docs/react-query/SuspenseQueries Suspensive Docs} + * @see {@link https://suspensive.org/docs/react-query/SuspenseQueries Suspensive Docs} * @example * ```tsx * import { SuspenseQueries } from '@suspensive/react-query' diff --git a/packages/react-query-5/src/SuspenseQuery.tsx b/packages/react-query-5/src/SuspenseQuery.tsx index 3a08b8117..842c145f4 100644 --- a/packages/react-query-5/src/SuspenseQuery.tsx +++ b/packages/react-query-5/src/SuspenseQuery.tsx @@ -10,7 +10,7 @@ import type { ReactNode } from 'react' /** * We provide these components to clearly express what causes suspense at the same depth. * `` serves to make `useSuspenseQuery` easier to use in jsx. - * @see {@link https://suspensive.org/en/docs/react-query/SuspenseQuery Suspensive Docs} + * @see {@link https://suspensive.org/docs/react-query/SuspenseQuery Suspensive Docs} * @example * ```tsx * import { SuspenseQuery } from '@suspensive/react-query' diff --git a/packages/react/src/DefaultProps.tsx b/packages/react/src/DefaultProps.tsx index 3cc5e7aa2..0b97e4178 100644 --- a/packages/react/src/DefaultProps.tsx +++ b/packages/react/src/DefaultProps.tsx @@ -62,7 +62,7 @@ interface DefaultPropsProviderProps extends PropsWithChildren { * } * ``` * - * @see {@link https://suspensive.org/en/docs/react/DefaultPropsProvider Suspensive Docs} + * @see {@link https://suspensive.org/docs/react/DefaultPropsProvider Suspensive Docs} */ export const DefaultPropsProvider = ({ defaultProps, children }: DefaultPropsProviderProps) => ( diff --git a/packages/react/src/ErrorBoundary.tsx b/packages/react/src/ErrorBoundary.tsx index 55fffe1b8..f2c7d9bb1 100644 --- a/packages/react/src/ErrorBoundary.tsx +++ b/packages/react/src/ErrorBoundary.tsx @@ -214,7 +214,7 @@ if (process.env.NODE_ENV === 'development') { /** * This hook provides a simple and reusable wrapper that you can use to wrap around your components. Any rendering errors in your components hierarchy can then be gracefully handled. - * @see {@link https://suspensive.org/en/docs/react/ErrorBoundary#useerrorboundary Suspensive Docs} + * @see {@link https://suspensive.org/docs/react/ErrorBoundary#useerrorboundary Suspensive Docs} */ // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters export const useErrorBoundary = () => { @@ -242,7 +242,7 @@ export const useErrorBoundary = () => { /** * This hook allows you to access the reset method and error objects without prop drilling. - * @see {@link https://suspensive.org/en/docs/react/ErrorBoundary#useerrorboundaryfallbackprops Suspensive Docs} + * @see {@link https://suspensive.org/docs/react/ErrorBoundary#useerrorboundaryfallbackprops Suspensive Docs} */ export const useErrorBoundaryFallbackProps = (): ErrorBoundaryFallbackProps => { const errorBoundary = useContext(ErrorBoundaryContext)