Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(react-query, react): Update jsdoc link from en/docs to docs #1368

Merged
merged 2 commits into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/chatty-socks-guess.md
Original file line number Diff line number Diff line change
@@ -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`
2 changes: 1 addition & 1 deletion packages/react-query-4/src/PrefetchInfiniteQuery.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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
* <PrefetchInfiniteQuery queryKey={['queryKey']} queryFn={queryFn} />
Expand Down
2 changes: 1 addition & 1 deletion packages/react-query-4/src/PrefetchQuery.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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
* <PrefetchQuery queryKey={['queryKey']} queryFn={queryFn} />
Expand Down
2 changes: 1 addition & 1 deletion packages/react-query-4/src/SuspenseInfiniteQuery.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {
/**
* We provide these components to clearly express what causes suspense at the same depth.
* `<SuspenseInfiniteQuery/>` 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'
Expand Down
2 changes: 1 addition & 1 deletion packages/react-query-4/src/SuspenseQueries.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { type SuspenseQueriesOptions, type SuspenseQueriesResults, useSuspenseQu
/**
* We provide these components to clearly express what causes suspense at the same depth.
* `<SuspenseQueries/>` 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'
Expand Down
2 changes: 1 addition & 1 deletion packages/react-query-4/src/SuspenseQuery.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { type UseSuspenseQueryOptions, type UseSuspenseQueryResult, useSuspenseQ
/**
* We provide these components to clearly express what causes suspense at the same depth.
* `<SuspenseQuery/>` 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'
Expand Down
2 changes: 1 addition & 1 deletion packages/react-query-4/src/queryOptions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion packages/react-query-4/src/usePrefetchInfiniteQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion packages/react-query-4/src/usePrefetchQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion packages/react-query-4/src/useSuspenseInfiniteQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion packages/react-query-4/src/useSuspenseQueries.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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<T extends any[]>({
queries,
Expand Down
2 changes: 1 addition & 1 deletion packages/react-query-4/src/useSuspenseQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion packages/react-query-5/src/PrefetchInfiniteQuery.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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
* <PrefetchInfiniteQuery queryKey={['queryKey']} queryFn={queryFn} />
Expand Down
2 changes: 1 addition & 1 deletion packages/react-query-5/src/PrefetchQuery.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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
* <PrefetchQuery queryKey={['queryKey']} queryFn={queryFn} />
Expand Down
2 changes: 1 addition & 1 deletion packages/react-query-5/src/SuspenseInfiniteQuery.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import type { ReactNode } from 'react'
/**
* We provide these components to clearly express what causes suspense at the same depth.
* `<SuspenseInfiniteQuery/>` 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'
Expand Down
2 changes: 1 addition & 1 deletion packages/react-query-5/src/SuspenseQueries.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import type { ReactNode } from 'react'
/**
* We provide these components to clearly express what causes suspense at the same depth.
* `<SuspenseQueries/>` 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'
Expand Down
2 changes: 1 addition & 1 deletion packages/react-query-5/src/SuspenseQuery.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import type { ReactNode } from 'react'
/**
* We provide these components to clearly express what causes suspense at the same depth.
* `<SuspenseQuery/>` 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'
Expand Down
2 changes: 1 addition & 1 deletion packages/react/src/DefaultProps.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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) => (
<DelayDefaultPropsContext.Provider value={defaultProps.Delay ?? {}}>
Expand Down
4 changes: 2 additions & 2 deletions packages/react/src/ErrorBoundary.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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 = <TError extends Error = Error>() => {
Expand Down Expand Up @@ -242,7 +242,7 @@ export const useErrorBoundary = <TError extends Error = Error>() => {

/**
* 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 = <TError extends Error = Error>(): ErrorBoundaryFallbackProps<TError> => {
const errorBoundary = useContext(ErrorBoundaryContext)
Expand Down
Loading