feat: add PageParam typing#5005

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.

Sign up for GitHub

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

Merged
TkDodo merged 6 commits into from
Feb 19, 2023
Merged

feat: add PageParam typing #5005

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
024684a
feat: add PageParam typing
ecyrbe Feb 19, 2023
a844ee3
feat(infinite-query): more typing
ecyrbe Feb 19, 2023
510f331
feat(infinite-query): make pageParam never by defaukt
ecyrbe Feb 19, 2023
20bcf1f
feat(infinite-query): PageParam type unknown for infinite queries
ecyrbe Feb 19, 2023
5605b87
fix(infinite-query): fix tests
ecyrbe Feb 19, 2023
d78b0bb
feat(infinite-query): add previous end next return TPageParam type
ecyrbe Feb 19, 2023
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
10 changes: 8 additions & 2 deletions packages/query-core/src/infiniteQueryBehavior.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type {
InfiniteData,
InfiniteQueryOptions,
QueryFunctionContext,
QueryKey,
} from './types'

export function infiniteQueryBehavior<
Expand DownExpand Up@@ -74,15 +75,20 @@ export function infiniteQueryBehavior<
return Promise.resolve(pages)
}

const queryFnContext: Omit<QueryFunctionContext, 'signal'> = {
const queryFnContext: Omit<
QueryFunctionContext<QueryKey, unknown>,
'signal'
> = {
queryKey: context.queryKey,
pageParam: param,
meta: context.options.meta,
}

addSignalProperty(queryFnContext)

const queryFnResult = queryFn(queryFnContext as QueryFunctionContext)
const queryFnResult = queryFn(
queryFnContext as QueryFunctionContext<QueryKey, unknown>,
)

const promise = Promise.resolve(queryFnResult).then((page) =>
buildNewPages(pages, param, page, previous),
Expand Down
1 change: 0 additions & 1 deletion packages/query-core/src/query.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -362,7 +362,6 @@ export class Query<
// Create query function context
const queryFnContext: Omit<QueryFunctionContext<TQueryKey>, 'signal'> = {
queryKey: this.queryKey,
pageParam: undefined,
meta: this.meta,
}

Expand Down
37 changes: 33 additions & 4 deletions packages/query-core/src/queryClient.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -275,8 +275,15 @@ export class QueryClient {
TError = RegisteredError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TPageParam = never,
>(
options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
options: FetchQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam
>,
): Promise<TData> {
const defaultedOptions = this.defaultQueryOptions(options)

Expand DownExpand Up@@ -308,8 +315,15 @@ export class QueryClient {
TError = RegisteredError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TPageParam = unknown,
>(
options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
options: FetchInfiniteQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam
>,
): Promise<InfiniteData<TData>> {
options.behavior = infiniteQueryBehavior<TQueryFnData, TError, TData>()
return this.fetchQuery(options)
Expand All@@ -320,8 +334,15 @@ export class QueryClient {
TError = RegisteredError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TPageParam = unknown,
>(
options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
options: FetchInfiniteQueryOptions<
TQueryFnData,
TError,
TData,
TQueryKey,
TPageParam
>,
): Promise<void> {
return this.fetchInfiniteQuery(options).then(noop).catch(noop)
}
Expand DownExpand Up@@ -405,9 +426,17 @@ export class QueryClient {
TData = TQueryFnData,
TQueryData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TPageParam = never,
>(
options?:
| QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
| QueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData,
TQueryKey,
TPageParam
>
| DefaultedQueryObserverOptions<
TQueryFnData,
TError,
Expand Down
1 change: 1 addition & 0 deletions packages/query-core/src/tests/query.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -200,6 +200,7 @@ describe('query', () => {
expect(queryFn).toHaveBeenCalledTimes(1)
const args = queryFn.mock.calls[0]![0]
expect(args).toBeDefined()
// @ts-expect-error page param should be undefined
expect(args.pageParam).toBeUndefined()
expect(args.queryKey).toEqual(key)
expect(args.signal).toBeInstanceOf(AbortSignal)
Expand Down
10 changes: 6 additions & 4 deletions packages/query-core/src/tests/queryClient.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -565,15 +565,16 @@ describe('queryClient', () => {
pageParams: [0],
} as const

const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
const fetchFn: QueryFunction<StrictData, StrictQueryKey, number> = () =>
Promise.resolve(data.pages[0])

await expect(
queryClient.fetchInfiniteQuery<
StrictData,
any,
StrictData,
StrictQueryKey
StrictQueryKey,
number
>({ queryKey: key, queryFn: fetchFn, defaultPageParam: 0 }),
).resolves.toEqual(data)
})
Expand DownExpand Up@@ -603,14 +604,15 @@ describe('queryClient', () => {
type StrictQueryKey = ['strict', ...ReturnType<typeof queryKey>]
const key: StrictQueryKey = ['strict', ...queryKey()]

const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
const fetchFn: QueryFunction<StrictData, StrictQueryKey, number> = () =>
Promise.resolve('data')

await queryClient.prefetchInfiniteQuery<
StrictData,
any,
StrictData,
StrictQueryKey
StrictQueryKey,
number
>({ queryKey: key, queryFn: fetchFn, defaultPageParam: 0 })

const result = queryClient.getQueryData(key)
Expand Down
74 changes: 48 additions & 26 deletions packages/query-core/src/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,17 +22,24 @@ export type QueryKey = readonly unknown[]
export type QueryFunction<
T = unknown,
TQueryKey extends QueryKey = QueryKey,
> = (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>
TPageParam = never,
> = (context: QueryFunctionContext<TQueryKey, TPageParam>) => T | Promise<T>

export interface QueryFunctionContext<
export type QueryFunctionContext<
TQueryKey extends QueryKey = QueryKey,
TPageParam = any,
> {
queryKey: TQueryKey
signal: AbortSignal
pageParam?: TPageParam
meta: QueryMeta | undefined
}
TPageParam = never,
> = [TPageParam] extends [never]
? {
queryKey: TQueryKey
signal: AbortSignal
meta: QueryMeta | undefined
}
: {
queryKey: TQueryKey
signal: AbortSignal
pageParam: TPageParam
meta: QueryMeta | undefined
}

export type InitialDataFunction<T> = () => T | undefined

Expand All@@ -50,15 +57,15 @@ export type QueryKeyHashFunction<TQueryKey extends QueryKey> = (
queryKey: TQueryKey,
) => string

export type GetPreviousPageParamFunction<TQueryFnData = unknown> = (
export type GetPreviousPageParamFunction<TPageParam, TQueryFnData = unknown> = (
firstPage: TQueryFnData,
allPages: TQueryFnData[],
) => unknown
) => TPageParam | undefined

export type GetNextPageParamFunction<TQueryFnData = unknown> = (
export type GetNextPageParamFunction<TPageParam, TQueryFnData = unknown> = (
lastPage: TQueryFnData,
allPages: TQueryFnData[],
) => unknown
) => TPageParam | undefined

export interface InfiniteData<TData> {
pages: TData[]
Expand All@@ -76,6 +83,7 @@ export interface QueryOptions<
TError = RegisteredError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TPageParam = never,
> {
/**
* If `false`, failed queries will not retry by default.
Expand All@@ -87,7 +95,7 @@ export interface QueryOptions<
retryDelay?: RetryDelayValue<TError>
networkMode?: NetworkMode
gcTime?: number
queryFn?: QueryFunction<TQueryFnData, TQueryKey>
queryFn?: QueryFunction<TQueryFnData, TQueryKey, TPageParam>
queryHash?: string
queryKey?: TQueryKey
queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>
Expand All@@ -114,22 +122,24 @@ export interface QueryOptions<
maxPages?: number
}

export interface DefaultPageParam {
defaultPageParam: unknown
export interface DefaultPageParam<TPageParam = unknown> {
defaultPageParam: TPageParam
}

export interface InfiniteQueryOptions<TQueryFnData = unknown>
extends DefaultPageParam {
export interface InfiniteQueryOptions<
TQueryFnData = unknown,
TPageParam = unknown,
> extends DefaultPageParam<TPageParam> {
/**
* This function can be set to automatically get the previous cursor for infinite queries.
* The result will also be used to determine the value of `hasPreviousPage`.
*/
getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>
getPreviousPageParam?: GetPreviousPageParamFunction<TPageParam, TQueryFnData>
/**
* This function can be set to automatically get the next cursor for infinite queries.
* The result will also be used to determine the value of `hasNextPage`.
*/
getNextPageParam: GetNextPageParamFunction<TQueryFnData>
getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>
}

export type ThrowErrors<
Expand All@@ -150,7 +160,14 @@ export interface QueryObserverOptions<
TData = TQueryFnData,
TQueryData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
> extends QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey> {
TPageParam = never,
> extends QueryOptions<
TQueryFnData,
TError,
TQueryData,
TQueryKey,
TPageParam
> {
/**
* Set this to `false` to disable automatic refetching when the query mounts or changes query keys.
* To refetch the query, use the `refetch` method returned from the `useQuery` instance.
Expand DownExpand Up@@ -289,14 +306,16 @@ export interface InfiniteQueryObserverOptions<
TData = TQueryFnData,
TQueryData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TPageParam = unknown,
> extends QueryObserverOptions<
TQueryFnData,
TError,
InfiniteData<TData>,
InfiniteData<TQueryData>,
TQueryKey
TQueryKey,
TPageParam
>,
InfiniteQueryOptions<TQueryFnData> {}
InfiniteQueryOptions<TQueryFnData, TPageParam> {}

export type DefaultedInfiniteQueryObserverOptions<
TQueryFnData = unknown,
Expand All@@ -320,8 +339,9 @@ export interface FetchQueryOptions<
TError = RegisteredError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TPageParam = never,
> extends WithRequired<
QueryOptions<TQueryFnData, TError, TData, TQueryKey>,
QueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>,
'queryKey'
> {
/**
Expand All@@ -336,13 +356,15 @@ export interface FetchInfiniteQueryOptions<
TError = RegisteredError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TPageParam = unknown,
> extends FetchQueryOptions<
TQueryFnData,
TError,
InfiniteData<TData>,
TQueryKey
TQueryKey,
TPageParam
>,
DefaultPageParam {}
DefaultPageParam<TPageParam> {}

export interface ResultOptions {
throwOnError?: boolean
Expand Down
4 changes: 3 additions & 1 deletion packages/react-query/src/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,13 +41,15 @@ export interface UseInfiniteQueryOptions<
TData = TQueryFnData,
TQueryData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TPageParam = unknown,
> extends WithRequired<
InfiniteQueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData,
TQueryKey
TQueryKey,
TPageParam
>,
'queryKey'
> {}
Expand Down
4 changes: 3 additions & 1 deletion packages/react-query/src/useInfiniteQuery.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,13 +14,15 @@ export function useInfiniteQuery<
TError = RegisteredError,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey,
TPageParam = unknown,
>(
options: UseInfiniteQueryOptions<
TQueryFnData,
TError,
TData,
TQueryFnData,
TQueryKey
TQueryKey,
TPageParam
>,
queryClient?: QueryClient,
): UseInfiniteQueryResult<TData, TError> {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat: add PageParam typing#5005

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.

 Sign up for GitHub

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

 Merged

TkDodo
merged 6 commits into

from

Feb 19, 2023
 Merged


feat: add PageParam typing
#5005
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
024684a

feat: add PageParam typing


ecyrbe Feb 19, 2023
a844ee3

feat(infinite-query): more typing


ecyrbe Feb 19, 2023
510f331

feat(infinite-query): make pageParam never by defaukt


ecyrbe Feb 19, 2023
20bcf1f

feat(infinite-query): PageParam type unknown for infinite queries


ecyrbe Feb 19, 2023
5605b87

fix(infinite-query): fix tests


ecyrbe Feb 19, 2023
d78b0bb

feat(infinite-query): add previous end next return TPageParam type


ecyrbe Feb 19, 2023

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


10 changes: 8 additions & 2 deletions
packages/query-core/src/infiniteQueryBehavior.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type {
 InfiniteData,
 InfiniteQueryOptions,
 QueryFunctionContext,
 QueryKey,
} from './types'

export function infiniteQueryBehavior<
Expand DownExpand Up@@ -74,15 +75,20 @@ export function infiniteQueryBehavior<
 return Promise.resolve(pages)
 }

 const queryFnContext: Omit<QueryFunctionContext, 'signal'> = {
 const queryFnContext: Omit<
 QueryFunctionContext<QueryKey, unknown>,
 'signal'
 > = {
 queryKey: context.queryKey,
 pageParam: param,
 meta: context.options.meta,
 }

 addSignalProperty(queryFnContext)

 const queryFnResult = queryFn(queryFnContext as QueryFunctionContext)
 const queryFnResult = queryFn(
 queryFnContext as QueryFunctionContext<QueryKey, unknown>,
 )

 const promise = Promise.resolve(queryFnResult).then((page) =>
 buildNewPages(pages, param, page, previous),
Expand Down

1 change: 0 additions & 1 deletion
packages/query-core/src/query.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -362,7 +362,6 @@ export class Query<
 // Create query function context
 const queryFnContext: Omit<QueryFunctionContext<TQueryKey>, 'signal'> = {
 queryKey: this.queryKey,
 pageParam: undefined,
 meta: this.meta,
 }

Expand Down

37 changes: 33 additions & 4 deletions
packages/query-core/src/queryClient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -275,8 +275,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
 >(
 options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<TData> {
 const defaultedOptions = this.defaultQueryOptions(options)

Expand DownExpand Up@@ -308,8 +315,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
 >(
 options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<InfiniteData<TData>> {
 options.behavior = infiniteQueryBehavior<TQueryFnData, TError, TData>()
 return this.fetchQuery(options)
Expand All@@ -320,8 +334,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
 >(
 options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<void> {
 return this.fetchInfiniteQuery(options).then(noop).catch(noop)
 }
Expand DownExpand Up@@ -405,9 +426,17 @@ export class QueryClient {
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
 >(
 options?:
 | QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
 | QueryObserverOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryData,
 TQueryKey,
 TPageParam
 >
 | DefaultedQueryObserverOptions<
 TQueryFnData,
 TError,
Expand Down

1 change: 1 addition & 0 deletions
packages/query-core/src/tests/query.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -200,6 +200,7 @@ describe('query', () => {
 expect(queryFn).toHaveBeenCalledTimes(1)
 const args = queryFn.mock.calls[0]![0]
 expect(args).toBeDefined()
 // @ts-expect-error page param should be undefined
 expect(args.pageParam).toBeUndefined()
 expect(args.queryKey).toEqual(key)
 expect(args.signal).toBeInstanceOf(AbortSignal)
Expand Down

10 changes: 6 additions & 4 deletions
packages/query-core/src/tests/queryClient.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -565,15 +565,16 @@ describe('queryClient', () => {
 pageParams: [0],
 } as const

 const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
 const fetchFn: QueryFunction<StrictData, StrictQueryKey, number> = () =>
 Promise.resolve(data.pages[0])

 await expect(
 queryClient.fetchInfiniteQuery<
 StrictData,
 any,
 StrictData,
 StrictQueryKey
 StrictQueryKey,
 number
 >({ queryKey: key, queryFn: fetchFn, defaultPageParam: 0 }),
 ).resolves.toEqual(data)
 })
Expand DownExpand Up@@ -603,14 +604,15 @@ describe('queryClient', () => {
 type StrictQueryKey = ['strict', ...ReturnType<typeof queryKey>]
 const key: StrictQueryKey = ['strict', ...queryKey()]

 const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
 const fetchFn: QueryFunction<StrictData, StrictQueryKey, number> = () =>
 Promise.resolve('data')

 await queryClient.prefetchInfiniteQuery<
 StrictData,
 any,
 StrictData,
 StrictQueryKey
 StrictQueryKey,
 number
 >({ queryKey: key, queryFn: fetchFn, defaultPageParam: 0 })

 const result = queryClient.getQueryData(key)
Expand Down

74 changes: 48 additions & 26 deletions
packages/query-core/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,17 +22,24 @@ export type QueryKey = readonly unknown[]
export type QueryFunction<
 T = unknown,
 TQueryKey extends QueryKey = QueryKey,
> = (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>
 TPageParam = never,
> = (context: QueryFunctionContext<TQueryKey, TPageParam>) => T | Promise<T>

export interface QueryFunctionContext<
export type QueryFunctionContext<
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = any,
> {
 queryKey: TQueryKey
 signal: AbortSignal
 pageParam?: TPageParam
 meta: QueryMeta | undefined
}
 TPageParam = never,
> = [TPageParam] extends [never]
 ? {
 queryKey: TQueryKey
 signal: AbortSignal
 meta: QueryMeta | undefined
 }
 : {
 queryKey: TQueryKey
 signal: AbortSignal
 pageParam: TPageParam
 meta: QueryMeta | undefined
 }

export type InitialDataFunction<T> = () => T | undefined

Expand All@@ -50,15 +57,15 @@ export type QueryKeyHashFunction<TQueryKey extends QueryKey> = (
 queryKey: TQueryKey,
) => string

export type GetPreviousPageParamFunction<TQueryFnData = unknown> = (
export type GetPreviousPageParamFunction<TPageParam, TQueryFnData = unknown> = (
 firstPage: TQueryFnData,
 allPages: TQueryFnData[],
) => unknown
) => TPageParam | undefined

export type GetNextPageParamFunction<TQueryFnData = unknown> = (
export type GetNextPageParamFunction<TPageParam, TQueryFnData = unknown> = (
 lastPage: TQueryFnData,
 allPages: TQueryFnData[],
) => unknown
) => TPageParam | undefined

export interface InfiniteData<TData> {
 pages: TData[]
Expand All@@ -76,6 +83,7 @@ export interface QueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
> {
 /**
 * If `false`, failed queries will not retry by default.
Expand All@@ -87,7 +95,7 @@ export interface QueryOptions<
 retryDelay?: RetryDelayValue<TError>
 networkMode?: NetworkMode
 gcTime?: number
 queryFn?: QueryFunction<TQueryFnData, TQueryKey>
 queryFn?: QueryFunction<TQueryFnData, TQueryKey, TPageParam>
 queryHash?: string
 queryKey?: TQueryKey
 queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>
Expand All@@ -114,22 +122,24 @@ export interface QueryOptions<
 maxPages?: number
}

export interface DefaultPageParam {
 defaultPageParam: unknown
export interface DefaultPageParam<TPageParam = unknown> {
 defaultPageParam: TPageParam
}

export interface InfiniteQueryOptions<TQueryFnData = unknown>
 extends DefaultPageParam {
export interface InfiniteQueryOptions<
 TQueryFnData = unknown,
 TPageParam = unknown,
> extends DefaultPageParam<TPageParam> {
 /**
 * This function can be set to automatically get the previous cursor for infinite queries.
 * The result will also be used to determine the value of `hasPreviousPage`.
 */
 getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>
 getPreviousPageParam?: GetPreviousPageParamFunction<TPageParam, TQueryFnData>
 /**
 * This function can be set to automatically get the next cursor for infinite queries.
 * The result will also be used to determine the value of `hasNextPage`.
 */
 getNextPageParam: GetNextPageParamFunction<TQueryFnData>
 getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>
}

export type ThrowErrors<
Expand All@@ -150,7 +160,14 @@ export interface QueryObserverOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
> extends QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey> {
 TPageParam = never,
> extends QueryOptions<
 TQueryFnData,
 TError,
 TQueryData,
 TQueryKey,
 TPageParam
 > {
 /**
 * Set this to `false` to disable automatic refetching when the query mounts or changes query keys.
 * To refetch the query, use the `refetch` method returned from the `useQuery` instance.
Expand DownExpand Up@@ -289,14 +306,16 @@ export interface InfiniteQueryObserverOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends QueryObserverOptions<
 TQueryFnData,
 TError,
 InfiniteData<TData>,
 InfiniteData<TQueryData>,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 InfiniteQueryOptions<TQueryFnData> {}
 InfiniteQueryOptions<TQueryFnData, TPageParam> {}

export type DefaultedInfiniteQueryObserverOptions<
 TQueryFnData = unknown,
Expand All@@ -320,8 +339,9 @@ export interface FetchQueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
> extends WithRequired<
 QueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 QueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>,
 'queryKey'
 > {
 /**
Expand All@@ -336,13 +356,15 @@ export interface FetchInfiniteQueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends FetchQueryOptions<
 TQueryFnData,
 TError,
 InfiniteData<TData>,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 DefaultPageParam {}
 DefaultPageParam<TPageParam> {}

export interface ResultOptions {
 throwOnError?: boolean
Expand Down

4 changes: 3 additions & 1 deletion
packages/react-query/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,13 +41,15 @@ export interface UseInfiniteQueryOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends WithRequired<
 InfiniteQueryObserverOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryData,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 'queryKey'
 > {}
Expand Down

4 changes: 3 additions & 1 deletion
packages/react-query/src/useInfiniteQuery.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,13 +14,15 @@ export function useInfiniteQuery<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
>(
 options: UseInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryFnData,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 queryClient?: QueryClient,
): UseInfiniteQueryResult<TData, TError> {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: add PageParam typing#5005

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.

 Sign up for GitHub

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

 Merged

TkDodo
merged 6 commits into

from

Feb 19, 2023
 Merged


feat: add PageParam typing
#5005
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
024684a

feat: add PageParam typing


ecyrbe Feb 19, 2023
a844ee3

feat(infinite-query): more typing


ecyrbe Feb 19, 2023
510f331

feat(infinite-query): make pageParam never by defaukt


ecyrbe Feb 19, 2023
20bcf1f

feat(infinite-query): PageParam type unknown for infinite queries


ecyrbe Feb 19, 2023
5605b87

fix(infinite-query): fix tests


ecyrbe Feb 19, 2023
d78b0bb

feat(infinite-query): add previous end next return TPageParam type


ecyrbe Feb 19, 2023

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


10 changes: 8 additions & 2 deletions
packages/query-core/src/infiniteQueryBehavior.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type {
 InfiniteData,
 InfiniteQueryOptions,
 QueryFunctionContext,
 QueryKey,
} from './types'

export function infiniteQueryBehavior<
Expand DownExpand Up@@ -74,15 +75,20 @@ export function infiniteQueryBehavior<
 return Promise.resolve(pages)
 }

 const queryFnContext: Omit<QueryFunctionContext, 'signal'> = {
 const queryFnContext: Omit<
 QueryFunctionContext<QueryKey, unknown>,
 'signal'
 > = {
 queryKey: context.queryKey,
 pageParam: param,
 meta: context.options.meta,
 }

 addSignalProperty(queryFnContext)

 const queryFnResult = queryFn(queryFnContext as QueryFunctionContext)
 const queryFnResult = queryFn(
 queryFnContext as QueryFunctionContext<QueryKey, unknown>,
 )

 const promise = Promise.resolve(queryFnResult).then((page) =>
 buildNewPages(pages, param, page, previous),
Expand Down

1 change: 0 additions & 1 deletion
packages/query-core/src/query.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -362,7 +362,6 @@ export class Query<
 // Create query function context
 const queryFnContext: Omit<QueryFunctionContext<TQueryKey>, 'signal'> = {
 queryKey: this.queryKey,
 pageParam: undefined,
 meta: this.meta,
 }

Expand Down

37 changes: 33 additions & 4 deletions
packages/query-core/src/queryClient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -275,8 +275,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
 >(
 options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<TData> {
 const defaultedOptions = this.defaultQueryOptions(options)

Expand DownExpand Up@@ -308,8 +315,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
 >(
 options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<InfiniteData<TData>> {
 options.behavior = infiniteQueryBehavior<TQueryFnData, TError, TData>()
 return this.fetchQuery(options)
Expand All@@ -320,8 +334,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
 >(
 options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<void> {
 return this.fetchInfiniteQuery(options).then(noop).catch(noop)
 }
Expand DownExpand Up@@ -405,9 +426,17 @@ export class QueryClient {
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
 >(
 options?:
 | QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
 | QueryObserverOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryData,
 TQueryKey,
 TPageParam
 >
 | DefaultedQueryObserverOptions<
 TQueryFnData,
 TError,
Expand Down

1 change: 1 addition & 0 deletions
packages/query-core/src/tests/query.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -200,6 +200,7 @@ describe('query', () => {
 expect(queryFn).toHaveBeenCalledTimes(1)
 const args = queryFn.mock.calls[0]![0]
 expect(args).toBeDefined()
 // @ts-expect-error page param should be undefined
 expect(args.pageParam).toBeUndefined()
 expect(args.queryKey).toEqual(key)
 expect(args.signal).toBeInstanceOf(AbortSignal)
Expand Down

10 changes: 6 additions & 4 deletions
packages/query-core/src/tests/queryClient.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -565,15 +565,16 @@ describe('queryClient', () => {
 pageParams: [0],
 } as const

 const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
 const fetchFn: QueryFunction<StrictData, StrictQueryKey, number> = () =>
 Promise.resolve(data.pages[0])

 await expect(
 queryClient.fetchInfiniteQuery<
 StrictData,
 any,
 StrictData,
 StrictQueryKey
 StrictQueryKey,
 number
 >({ queryKey: key, queryFn: fetchFn, defaultPageParam: 0 }),
 ).resolves.toEqual(data)
 })
Expand DownExpand Up@@ -603,14 +604,15 @@ describe('queryClient', () => {
 type StrictQueryKey = ['strict', ...ReturnType<typeof queryKey>]
 const key: StrictQueryKey = ['strict', ...queryKey()]

 const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
 const fetchFn: QueryFunction<StrictData, StrictQueryKey, number> = () =>
 Promise.resolve('data')

 await queryClient.prefetchInfiniteQuery<
 StrictData,
 any,
 StrictData,
 StrictQueryKey
 StrictQueryKey,
 number
 >({ queryKey: key, queryFn: fetchFn, defaultPageParam: 0 })

 const result = queryClient.getQueryData(key)
Expand Down

74 changes: 48 additions & 26 deletions
packages/query-core/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,17 +22,24 @@ export type QueryKey = readonly unknown[]
export type QueryFunction<
 T = unknown,
 TQueryKey extends QueryKey = QueryKey,
> = (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>
 TPageParam = never,
> = (context: QueryFunctionContext<TQueryKey, TPageParam>) => T | Promise<T>

export interface QueryFunctionContext<
export type QueryFunctionContext<
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = any,
> {
 queryKey: TQueryKey
 signal: AbortSignal
 pageParam?: TPageParam
 meta: QueryMeta | undefined
}
 TPageParam = never,
> = [TPageParam] extends [never]
 ? {
 queryKey: TQueryKey
 signal: AbortSignal
 meta: QueryMeta | undefined
 }
 : {
 queryKey: TQueryKey
 signal: AbortSignal
 pageParam: TPageParam
 meta: QueryMeta | undefined
 }

export type InitialDataFunction<T> = () => T | undefined

Expand All@@ -50,15 +57,15 @@ export type QueryKeyHashFunction<TQueryKey extends QueryKey> = (
 queryKey: TQueryKey,
) => string

export type GetPreviousPageParamFunction<TQueryFnData = unknown> = (
export type GetPreviousPageParamFunction<TPageParam, TQueryFnData = unknown> = (
 firstPage: TQueryFnData,
 allPages: TQueryFnData[],
) => unknown
) => TPageParam | undefined

export type GetNextPageParamFunction<TQueryFnData = unknown> = (
export type GetNextPageParamFunction<TPageParam, TQueryFnData = unknown> = (
 lastPage: TQueryFnData,
 allPages: TQueryFnData[],
) => unknown
) => TPageParam | undefined

export interface InfiniteData<TData> {
 pages: TData[]
Expand All@@ -76,6 +83,7 @@ export interface QueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
> {
 /**
 * If `false`, failed queries will not retry by default.
Expand All@@ -87,7 +95,7 @@ export interface QueryOptions<
 retryDelay?: RetryDelayValue<TError>
 networkMode?: NetworkMode
 gcTime?: number
 queryFn?: QueryFunction<TQueryFnData, TQueryKey>
 queryFn?: QueryFunction<TQueryFnData, TQueryKey, TPageParam>
 queryHash?: string
 queryKey?: TQueryKey
 queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>
Expand All@@ -114,22 +122,24 @@ export interface QueryOptions<
 maxPages?: number
}

export interface DefaultPageParam {
 defaultPageParam: unknown
export interface DefaultPageParam<TPageParam = unknown> {
 defaultPageParam: TPageParam
}

export interface InfiniteQueryOptions<TQueryFnData = unknown>
 extends DefaultPageParam {
export interface InfiniteQueryOptions<
 TQueryFnData = unknown,
 TPageParam = unknown,
> extends DefaultPageParam<TPageParam> {
 /**
 * This function can be set to automatically get the previous cursor for infinite queries.
 * The result will also be used to determine the value of `hasPreviousPage`.
 */
 getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>
 getPreviousPageParam?: GetPreviousPageParamFunction<TPageParam, TQueryFnData>
 /**
 * This function can be set to automatically get the next cursor for infinite queries.
 * The result will also be used to determine the value of `hasNextPage`.
 */
 getNextPageParam: GetNextPageParamFunction<TQueryFnData>
 getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>
}

export type ThrowErrors<
Expand All@@ -150,7 +160,14 @@ export interface QueryObserverOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
> extends QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey> {
 TPageParam = never,
> extends QueryOptions<
 TQueryFnData,
 TError,
 TQueryData,
 TQueryKey,
 TPageParam
 > {
 /**
 * Set this to `false` to disable automatic refetching when the query mounts or changes query keys.
 * To refetch the query, use the `refetch` method returned from the `useQuery` instance.
Expand DownExpand Up@@ -289,14 +306,16 @@ export interface InfiniteQueryObserverOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends QueryObserverOptions<
 TQueryFnData,
 TError,
 InfiniteData<TData>,
 InfiniteData<TQueryData>,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 InfiniteQueryOptions<TQueryFnData> {}
 InfiniteQueryOptions<TQueryFnData, TPageParam> {}

export type DefaultedInfiniteQueryObserverOptions<
 TQueryFnData = unknown,
Expand All@@ -320,8 +339,9 @@ export interface FetchQueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
> extends WithRequired<
 QueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 QueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>,
 'queryKey'
 > {
 /**
Expand All@@ -336,13 +356,15 @@ export interface FetchInfiniteQueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends FetchQueryOptions<
 TQueryFnData,
 TError,
 InfiniteData<TData>,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 DefaultPageParam {}
 DefaultPageParam<TPageParam> {}

export interface ResultOptions {
 throwOnError?: boolean
Expand Down

4 changes: 3 additions & 1 deletion
packages/react-query/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,13 +41,15 @@ export interface UseInfiniteQueryOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends WithRequired<
 InfiniteQueryObserverOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryData,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 'queryKey'
 > {}
Expand Down

4 changes: 3 additions & 1 deletion
packages/react-query/src/useInfiniteQuery.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,13 +14,15 @@ export function useInfiniteQuery<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
>(
 options: UseInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryFnData,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 queryClient?: QueryClient,
): UseInfiniteQueryResult<TData, TError> {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: add PageParam typing#5005

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.

 Sign up for GitHub

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

 Merged

TkDodo
merged 6 commits into

from

Feb 19, 2023
 Merged


feat: add PageParam typing
#5005
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
024684a

feat: add PageParam typing


ecyrbe Feb 19, 2023
a844ee3

feat(infinite-query): more typing


ecyrbe Feb 19, 2023
510f331

feat(infinite-query): make pageParam never by defaukt


ecyrbe Feb 19, 2023
20bcf1f

feat(infinite-query): PageParam type unknown for infinite queries


ecyrbe Feb 19, 2023
5605b87

fix(infinite-query): fix tests


ecyrbe Feb 19, 2023
d78b0bb

feat(infinite-query): add previous end next return TPageParam type


ecyrbe Feb 19, 2023

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


10 changes: 8 additions & 2 deletions
packages/query-core/src/infiniteQueryBehavior.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type {
 InfiniteData,
 InfiniteQueryOptions,
 QueryFunctionContext,
 QueryKey,
} from './types'

export function infiniteQueryBehavior<
Expand DownExpand Up@@ -74,15 +75,20 @@ export function infiniteQueryBehavior<
 return Promise.resolve(pages)
 }

 const queryFnContext: Omit<QueryFunctionContext, 'signal'> = {
 const queryFnContext: Omit<
 QueryFunctionContext<QueryKey, unknown>,
 'signal'
 > = {
 queryKey: context.queryKey,
 pageParam: param,
 meta: context.options.meta,
 }

 addSignalProperty(queryFnContext)

 const queryFnResult = queryFn(queryFnContext as QueryFunctionContext)
 const queryFnResult = queryFn(
 queryFnContext as QueryFunctionContext<QueryKey, unknown>,
 )

 const promise = Promise.resolve(queryFnResult).then((page) =>
 buildNewPages(pages, param, page, previous),
Expand Down

1 change: 0 additions & 1 deletion
packages/query-core/src/query.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -362,7 +362,6 @@ export class Query<
 // Create query function context
 const queryFnContext: Omit<QueryFunctionContext<TQueryKey>, 'signal'> = {
 queryKey: this.queryKey,
 pageParam: undefined,
 meta: this.meta,
 }

Expand Down

37 changes: 33 additions & 4 deletions
packages/query-core/src/queryClient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -275,8 +275,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
 >(
 options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<TData> {
 const defaultedOptions = this.defaultQueryOptions(options)

Expand DownExpand Up@@ -308,8 +315,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
 >(
 options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<InfiniteData<TData>> {
 options.behavior = infiniteQueryBehavior<TQueryFnData, TError, TData>()
 return this.fetchQuery(options)
Expand All@@ -320,8 +334,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
 >(
 options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<void> {
 return this.fetchInfiniteQuery(options).then(noop).catch(noop)
 }
Expand DownExpand Up@@ -405,9 +426,17 @@ export class QueryClient {
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
 >(
 options?:
 | QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
 | QueryObserverOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryData,
 TQueryKey,
 TPageParam
 >
 | DefaultedQueryObserverOptions<
 TQueryFnData,
 TError,
Expand Down

1 change: 1 addition & 0 deletions
packages/query-core/src/tests/query.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -200,6 +200,7 @@ describe('query', () => {
 expect(queryFn).toHaveBeenCalledTimes(1)
 const args = queryFn.mock.calls[0]![0]
 expect(args).toBeDefined()
 // @ts-expect-error page param should be undefined
 expect(args.pageParam).toBeUndefined()
 expect(args.queryKey).toEqual(key)
 expect(args.signal).toBeInstanceOf(AbortSignal)
Expand Down

10 changes: 6 additions & 4 deletions
packages/query-core/src/tests/queryClient.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -565,15 +565,16 @@ describe('queryClient', () => {
 pageParams: [0],
 } as const

 const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
 const fetchFn: QueryFunction<StrictData, StrictQueryKey, number> = () =>
 Promise.resolve(data.pages[0])

 await expect(
 queryClient.fetchInfiniteQuery<
 StrictData,
 any,
 StrictData,
 StrictQueryKey
 StrictQueryKey,
 number
 >({ queryKey: key, queryFn: fetchFn, defaultPageParam: 0 }),
 ).resolves.toEqual(data)
 })
Expand DownExpand Up@@ -603,14 +604,15 @@ describe('queryClient', () => {
 type StrictQueryKey = ['strict', ...ReturnType<typeof queryKey>]
 const key: StrictQueryKey = ['strict', ...queryKey()]

 const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
 const fetchFn: QueryFunction<StrictData, StrictQueryKey, number> = () =>
 Promise.resolve('data')

 await queryClient.prefetchInfiniteQuery<
 StrictData,
 any,
 StrictData,
 StrictQueryKey
 StrictQueryKey,
 number
 >({ queryKey: key, queryFn: fetchFn, defaultPageParam: 0 })

 const result = queryClient.getQueryData(key)
Expand Down

74 changes: 48 additions & 26 deletions
packages/query-core/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,17 +22,24 @@ export type QueryKey = readonly unknown[]
export type QueryFunction<
 T = unknown,
 TQueryKey extends QueryKey = QueryKey,
> = (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>
 TPageParam = never,
> = (context: QueryFunctionContext<TQueryKey, TPageParam>) => T | Promise<T>

export interface QueryFunctionContext<
export type QueryFunctionContext<
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = any,
> {
 queryKey: TQueryKey
 signal: AbortSignal
 pageParam?: TPageParam
 meta: QueryMeta | undefined
}
 TPageParam = never,
> = [TPageParam] extends [never]
 ? {
 queryKey: TQueryKey
 signal: AbortSignal
 meta: QueryMeta | undefined
 }
 : {
 queryKey: TQueryKey
 signal: AbortSignal
 pageParam: TPageParam
 meta: QueryMeta | undefined
 }

export type InitialDataFunction<T> = () => T | undefined

Expand All@@ -50,15 +57,15 @@ export type QueryKeyHashFunction<TQueryKey extends QueryKey> = (
 queryKey: TQueryKey,
) => string

export type GetPreviousPageParamFunction<TQueryFnData = unknown> = (
export type GetPreviousPageParamFunction<TPageParam, TQueryFnData = unknown> = (
 firstPage: TQueryFnData,
 allPages: TQueryFnData[],
) => unknown
) => TPageParam | undefined

export type GetNextPageParamFunction<TQueryFnData = unknown> = (
export type GetNextPageParamFunction<TPageParam, TQueryFnData = unknown> = (
 lastPage: TQueryFnData,
 allPages: TQueryFnData[],
) => unknown
) => TPageParam | undefined

export interface InfiniteData<TData> {
 pages: TData[]
Expand All@@ -76,6 +83,7 @@ export interface QueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
> {
 /**
 * If `false`, failed queries will not retry by default.
Expand All@@ -87,7 +95,7 @@ export interface QueryOptions<
 retryDelay?: RetryDelayValue<TError>
 networkMode?: NetworkMode
 gcTime?: number
 queryFn?: QueryFunction<TQueryFnData, TQueryKey>
 queryFn?: QueryFunction<TQueryFnData, TQueryKey, TPageParam>
 queryHash?: string
 queryKey?: TQueryKey
 queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>
Expand All@@ -114,22 +122,24 @@ export interface QueryOptions<
 maxPages?: number
}

export interface DefaultPageParam {
 defaultPageParam: unknown
export interface DefaultPageParam<TPageParam = unknown> {
 defaultPageParam: TPageParam
}

export interface InfiniteQueryOptions<TQueryFnData = unknown>
 extends DefaultPageParam {
export interface InfiniteQueryOptions<
 TQueryFnData = unknown,
 TPageParam = unknown,
> extends DefaultPageParam<TPageParam> {
 /**
 * This function can be set to automatically get the previous cursor for infinite queries.
 * The result will also be used to determine the value of `hasPreviousPage`.
 */
 getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>
 getPreviousPageParam?: GetPreviousPageParamFunction<TPageParam, TQueryFnData>
 /**
 * This function can be set to automatically get the next cursor for infinite queries.
 * The result will also be used to determine the value of `hasNextPage`.
 */
 getNextPageParam: GetNextPageParamFunction<TQueryFnData>
 getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>
}

export type ThrowErrors<
Expand All@@ -150,7 +160,14 @@ export interface QueryObserverOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
> extends QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey> {
 TPageParam = never,
> extends QueryOptions<
 TQueryFnData,
 TError,
 TQueryData,
 TQueryKey,
 TPageParam
 > {
 /**
 * Set this to `false` to disable automatic refetching when the query mounts or changes query keys.
 * To refetch the query, use the `refetch` method returned from the `useQuery` instance.
Expand DownExpand Up@@ -289,14 +306,16 @@ export interface InfiniteQueryObserverOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends QueryObserverOptions<
 TQueryFnData,
 TError,
 InfiniteData<TData>,
 InfiniteData<TQueryData>,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 InfiniteQueryOptions<TQueryFnData> {}
 InfiniteQueryOptions<TQueryFnData, TPageParam> {}

export type DefaultedInfiniteQueryObserverOptions<
 TQueryFnData = unknown,
Expand All@@ -320,8 +339,9 @@ export interface FetchQueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
> extends WithRequired<
 QueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 QueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>,
 'queryKey'
 > {
 /**
Expand All@@ -336,13 +356,15 @@ export interface FetchInfiniteQueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends FetchQueryOptions<
 TQueryFnData,
 TError,
 InfiniteData<TData>,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 DefaultPageParam {}
 DefaultPageParam<TPageParam> {}

export interface ResultOptions {
 throwOnError?: boolean
Expand Down

4 changes: 3 additions & 1 deletion
packages/react-query/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,13 +41,15 @@ export interface UseInfiniteQueryOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends WithRequired<
 InfiniteQueryObserverOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryData,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 'queryKey'
 > {}
Expand Down

4 changes: 3 additions & 1 deletion
packages/react-query/src/useInfiniteQuery.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,13 +14,15 @@ export function useInfiniteQuery<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
>(
 options: UseInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryFnData,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 queryClient?: QueryClient,
): UseInfiniteQueryResult<TData, TError> {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat: add PageParam typing#5005

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.

 Sign up for GitHub

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

 Merged

TkDodo
merged 6 commits into

from

Feb 19, 2023
 Merged


feat: add PageParam typing
#5005
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
024684a

feat: add PageParam typing


ecyrbe Feb 19, 2023
a844ee3

feat(infinite-query): more typing


ecyrbe Feb 19, 2023
510f331

feat(infinite-query): make pageParam never by defaukt


ecyrbe Feb 19, 2023
20bcf1f

feat(infinite-query): PageParam type unknown for infinite queries


ecyrbe Feb 19, 2023
5605b87

fix(infinite-query): fix tests


ecyrbe Feb 19, 2023
d78b0bb

feat(infinite-query): add previous end next return TPageParam type


ecyrbe Feb 19, 2023

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


10 changes: 8 additions & 2 deletions
packages/query-core/src/infiniteQueryBehavior.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type {
 InfiniteData,
 InfiniteQueryOptions,
 QueryFunctionContext,
 QueryKey,
} from './types'

export function infiniteQueryBehavior<
Expand DownExpand Up@@ -74,15 +75,20 @@ export function infiniteQueryBehavior<
 return Promise.resolve(pages)
 }

 const queryFnContext: Omit<QueryFunctionContext, 'signal'> = {
 const queryFnContext: Omit<
 QueryFunctionContext<QueryKey, unknown>,
 'signal'
 > = {
 queryKey: context.queryKey,
 pageParam: param,
 meta: context.options.meta,
 }

 addSignalProperty(queryFnContext)

 const queryFnResult = queryFn(queryFnContext as QueryFunctionContext)
 const queryFnResult = queryFn(
 queryFnContext as QueryFunctionContext<QueryKey, unknown>,
 )

 const promise = Promise.resolve(queryFnResult).then((page) =>
 buildNewPages(pages, param, page, previous),
Expand Down

1 change: 0 additions & 1 deletion
packages/query-core/src/query.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -362,7 +362,6 @@ export class Query<
 // Create query function context
 const queryFnContext: Omit<QueryFunctionContext<TQueryKey>, 'signal'> = {
 queryKey: this.queryKey,
 pageParam: undefined,
 meta: this.meta,
 }

Expand Down

37 changes: 33 additions & 4 deletions
packages/query-core/src/queryClient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -275,8 +275,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
 >(
 options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<TData> {
 const defaultedOptions = this.defaultQueryOptions(options)

Expand DownExpand Up@@ -308,8 +315,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
 >(
 options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<InfiniteData<TData>> {
 options.behavior = infiniteQueryBehavior<TQueryFnData, TError, TData>()
 return this.fetchQuery(options)
Expand All@@ -320,8 +334,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
 >(
 options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<void> {
 return this.fetchInfiniteQuery(options).then(noop).catch(noop)
 }
Expand DownExpand Up@@ -405,9 +426,17 @@ export class QueryClient {
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
 >(
 options?:
 | QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
 | QueryObserverOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryData,
 TQueryKey,
 TPageParam
 >
 | DefaultedQueryObserverOptions<
 TQueryFnData,
 TError,
Expand Down

1 change: 1 addition & 0 deletions
packages/query-core/src/tests/query.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -200,6 +200,7 @@ describe('query', () => {
 expect(queryFn).toHaveBeenCalledTimes(1)
 const args = queryFn.mock.calls[0]![0]
 expect(args).toBeDefined()
 // @ts-expect-error page param should be undefined
 expect(args.pageParam).toBeUndefined()
 expect(args.queryKey).toEqual(key)
 expect(args.signal).toBeInstanceOf(AbortSignal)
Expand Down

10 changes: 6 additions & 4 deletions
packages/query-core/src/tests/queryClient.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -565,15 +565,16 @@ describe('queryClient', () => {
 pageParams: [0],
 } as const

 const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
 const fetchFn: QueryFunction<StrictData, StrictQueryKey, number> = () =>
 Promise.resolve(data.pages[0])

 await expect(
 queryClient.fetchInfiniteQuery<
 StrictData,
 any,
 StrictData,
 StrictQueryKey
 StrictQueryKey,
 number
 >({ queryKey: key, queryFn: fetchFn, defaultPageParam: 0 }),
 ).resolves.toEqual(data)
 })
Expand DownExpand Up@@ -603,14 +604,15 @@ describe('queryClient', () => {
 type StrictQueryKey = ['strict', ...ReturnType<typeof queryKey>]
 const key: StrictQueryKey = ['strict', ...queryKey()]

 const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
 const fetchFn: QueryFunction<StrictData, StrictQueryKey, number> = () =>
 Promise.resolve('data')

 await queryClient.prefetchInfiniteQuery<
 StrictData,
 any,
 StrictData,
 StrictQueryKey
 StrictQueryKey,
 number
 >({ queryKey: key, queryFn: fetchFn, defaultPageParam: 0 })

 const result = queryClient.getQueryData(key)
Expand Down

74 changes: 48 additions & 26 deletions
packages/query-core/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,17 +22,24 @@ export type QueryKey = readonly unknown[]
export type QueryFunction<
 T = unknown,
 TQueryKey extends QueryKey = QueryKey,
> = (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>
 TPageParam = never,
> = (context: QueryFunctionContext<TQueryKey, TPageParam>) => T | Promise<T>

export interface QueryFunctionContext<
export type QueryFunctionContext<
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = any,
> {
 queryKey: TQueryKey
 signal: AbortSignal
 pageParam?: TPageParam
 meta: QueryMeta | undefined
}
 TPageParam = never,
> = [TPageParam] extends [never]
 ? {
 queryKey: TQueryKey
 signal: AbortSignal
 meta: QueryMeta | undefined
 }
 : {
 queryKey: TQueryKey
 signal: AbortSignal
 pageParam: TPageParam
 meta: QueryMeta | undefined
 }

export type InitialDataFunction<T> = () => T | undefined

Expand All@@ -50,15 +57,15 @@ export type QueryKeyHashFunction<TQueryKey extends QueryKey> = (
 queryKey: TQueryKey,
) => string

export type GetPreviousPageParamFunction<TQueryFnData = unknown> = (
export type GetPreviousPageParamFunction<TPageParam, TQueryFnData = unknown> = (
 firstPage: TQueryFnData,
 allPages: TQueryFnData[],
) => unknown
) => TPageParam | undefined

export type GetNextPageParamFunction<TQueryFnData = unknown> = (
export type GetNextPageParamFunction<TPageParam, TQueryFnData = unknown> = (
 lastPage: TQueryFnData,
 allPages: TQueryFnData[],
) => unknown
) => TPageParam | undefined

export interface InfiniteData<TData> {
 pages: TData[]
Expand All@@ -76,6 +83,7 @@ export interface QueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
> {
 /**
 * If `false`, failed queries will not retry by default.
Expand All@@ -87,7 +95,7 @@ export interface QueryOptions<
 retryDelay?: RetryDelayValue<TError>
 networkMode?: NetworkMode
 gcTime?: number
 queryFn?: QueryFunction<TQueryFnData, TQueryKey>
 queryFn?: QueryFunction<TQueryFnData, TQueryKey, TPageParam>
 queryHash?: string
 queryKey?: TQueryKey
 queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>
Expand All@@ -114,22 +122,24 @@ export interface QueryOptions<
 maxPages?: number
}

export interface DefaultPageParam {
 defaultPageParam: unknown
export interface DefaultPageParam<TPageParam = unknown> {
 defaultPageParam: TPageParam
}

export interface InfiniteQueryOptions<TQueryFnData = unknown>
 extends DefaultPageParam {
export interface InfiniteQueryOptions<
 TQueryFnData = unknown,
 TPageParam = unknown,
> extends DefaultPageParam<TPageParam> {
 /**
 * This function can be set to automatically get the previous cursor for infinite queries.
 * The result will also be used to determine the value of `hasPreviousPage`.
 */
 getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>
 getPreviousPageParam?: GetPreviousPageParamFunction<TPageParam, TQueryFnData>
 /**
 * This function can be set to automatically get the next cursor for infinite queries.
 * The result will also be used to determine the value of `hasNextPage`.
 */
 getNextPageParam: GetNextPageParamFunction<TQueryFnData>
 getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>
}

export type ThrowErrors<
Expand All@@ -150,7 +160,14 @@ export interface QueryObserverOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
> extends QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey> {
 TPageParam = never,
> extends QueryOptions<
 TQueryFnData,
 TError,
 TQueryData,
 TQueryKey,
 TPageParam
 > {
 /**
 * Set this to `false` to disable automatic refetching when the query mounts or changes query keys.
 * To refetch the query, use the `refetch` method returned from the `useQuery` instance.
Expand DownExpand Up@@ -289,14 +306,16 @@ export interface InfiniteQueryObserverOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends QueryObserverOptions<
 TQueryFnData,
 TError,
 InfiniteData<TData>,
 InfiniteData<TQueryData>,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 InfiniteQueryOptions<TQueryFnData> {}
 InfiniteQueryOptions<TQueryFnData, TPageParam> {}

export type DefaultedInfiniteQueryObserverOptions<
 TQueryFnData = unknown,
Expand All@@ -320,8 +339,9 @@ export interface FetchQueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
> extends WithRequired<
 QueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 QueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>,
 'queryKey'
 > {
 /**
Expand All@@ -336,13 +356,15 @@ export interface FetchInfiniteQueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends FetchQueryOptions<
 TQueryFnData,
 TError,
 InfiniteData<TData>,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 DefaultPageParam {}
 DefaultPageParam<TPageParam> {}

export interface ResultOptions {
 throwOnError?: boolean
Expand Down

4 changes: 3 additions & 1 deletion
packages/react-query/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,13 +41,15 @@ export interface UseInfiniteQueryOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends WithRequired<
 InfiniteQueryObserverOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryData,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 'queryKey'
 > {}
Expand Down

4 changes: 3 additions & 1 deletion
packages/react-query/src/useInfiniteQuery.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,13 +14,15 @@ export function useInfiniteQuery<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
>(
 options: UseInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryFnData,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 queryClient?: QueryClient,
): UseInfiniteQueryResult<TData, TError> {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: add PageParam typing#5005

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.

 Sign up for GitHub

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

 Merged

TkDodo
merged 6 commits into

from

Feb 19, 2023
 Merged


feat: add PageParam typing
#5005
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
024684a

feat: add PageParam typing


ecyrbe Feb 19, 2023
a844ee3

feat(infinite-query): more typing


ecyrbe Feb 19, 2023
510f331

feat(infinite-query): make pageParam never by defaukt


ecyrbe Feb 19, 2023
20bcf1f

feat(infinite-query): PageParam type unknown for infinite queries


ecyrbe Feb 19, 2023
5605b87

fix(infinite-query): fix tests


ecyrbe Feb 19, 2023
d78b0bb

feat(infinite-query): add previous end next return TPageParam type


ecyrbe Feb 19, 2023

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


10 changes: 8 additions & 2 deletions
packages/query-core/src/infiniteQueryBehavior.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type {
 InfiniteData,
 InfiniteQueryOptions,
 QueryFunctionContext,
 QueryKey,
} from './types'

export function infiniteQueryBehavior<
Expand DownExpand Up@@ -74,15 +75,20 @@ export function infiniteQueryBehavior<
 return Promise.resolve(pages)
 }

 const queryFnContext: Omit<QueryFunctionContext, 'signal'> = {
 const queryFnContext: Omit<
 QueryFunctionContext<QueryKey, unknown>,
 'signal'
 > = {
 queryKey: context.queryKey,
 pageParam: param,
 meta: context.options.meta,
 }

 addSignalProperty(queryFnContext)

 const queryFnResult = queryFn(queryFnContext as QueryFunctionContext)
 const queryFnResult = queryFn(
 queryFnContext as QueryFunctionContext<QueryKey, unknown>,
 )

 const promise = Promise.resolve(queryFnResult).then((page) =>
 buildNewPages(pages, param, page, previous),
Expand Down

1 change: 0 additions & 1 deletion
packages/query-core/src/query.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -362,7 +362,6 @@ export class Query<
 // Create query function context
 const queryFnContext: Omit<QueryFunctionContext<TQueryKey>, 'signal'> = {
 queryKey: this.queryKey,
 pageParam: undefined,
 meta: this.meta,
 }

Expand Down

37 changes: 33 additions & 4 deletions
packages/query-core/src/queryClient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -275,8 +275,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
 >(
 options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<TData> {
 const defaultedOptions = this.defaultQueryOptions(options)

Expand DownExpand Up@@ -308,8 +315,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
 >(
 options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<InfiniteData<TData>> {
 options.behavior = infiniteQueryBehavior<TQueryFnData, TError, TData>()
 return this.fetchQuery(options)
Expand All@@ -320,8 +334,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
 >(
 options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<void> {
 return this.fetchInfiniteQuery(options).then(noop).catch(noop)
 }
Expand DownExpand Up@@ -405,9 +426,17 @@ export class QueryClient {
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
 >(
 options?:
 | QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
 | QueryObserverOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryData,
 TQueryKey,
 TPageParam
 >
 | DefaultedQueryObserverOptions<
 TQueryFnData,
 TError,
Expand Down

1 change: 1 addition & 0 deletions
packages/query-core/src/tests/query.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -200,6 +200,7 @@ describe('query', () => {
 expect(queryFn).toHaveBeenCalledTimes(1)
 const args = queryFn.mock.calls[0]![0]
 expect(args).toBeDefined()
 // @ts-expect-error page param should be undefined
 expect(args.pageParam).toBeUndefined()
 expect(args.queryKey).toEqual(key)
 expect(args.signal).toBeInstanceOf(AbortSignal)
Expand Down

10 changes: 6 additions & 4 deletions
packages/query-core/src/tests/queryClient.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -565,15 +565,16 @@ describe('queryClient', () => {
 pageParams: [0],
 } as const

 const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
 const fetchFn: QueryFunction<StrictData, StrictQueryKey, number> = () =>
 Promise.resolve(data.pages[0])

 await expect(
 queryClient.fetchInfiniteQuery<
 StrictData,
 any,
 StrictData,
 StrictQueryKey
 StrictQueryKey,
 number
 >({ queryKey: key, queryFn: fetchFn, defaultPageParam: 0 }),
 ).resolves.toEqual(data)
 })
Expand DownExpand Up@@ -603,14 +604,15 @@ describe('queryClient', () => {
 type StrictQueryKey = ['strict', ...ReturnType<typeof queryKey>]
 const key: StrictQueryKey = ['strict', ...queryKey()]

 const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
 const fetchFn: QueryFunction<StrictData, StrictQueryKey, number> = () =>
 Promise.resolve('data')

 await queryClient.prefetchInfiniteQuery<
 StrictData,
 any,
 StrictData,
 StrictQueryKey
 StrictQueryKey,
 number
 >({ queryKey: key, queryFn: fetchFn, defaultPageParam: 0 })

 const result = queryClient.getQueryData(key)
Expand Down

74 changes: 48 additions & 26 deletions
packages/query-core/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,17 +22,24 @@ export type QueryKey = readonly unknown[]
export type QueryFunction<
 T = unknown,
 TQueryKey extends QueryKey = QueryKey,
> = (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>
 TPageParam = never,
> = (context: QueryFunctionContext<TQueryKey, TPageParam>) => T | Promise<T>

export interface QueryFunctionContext<
export type QueryFunctionContext<
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = any,
> {
 queryKey: TQueryKey
 signal: AbortSignal
 pageParam?: TPageParam
 meta: QueryMeta | undefined
}
 TPageParam = never,
> = [TPageParam] extends [never]
 ? {
 queryKey: TQueryKey
 signal: AbortSignal
 meta: QueryMeta | undefined
 }
 : {
 queryKey: TQueryKey
 signal: AbortSignal
 pageParam: TPageParam
 meta: QueryMeta | undefined
 }

export type InitialDataFunction<T> = () => T | undefined

Expand All@@ -50,15 +57,15 @@ export type QueryKeyHashFunction<TQueryKey extends QueryKey> = (
 queryKey: TQueryKey,
) => string

export type GetPreviousPageParamFunction<TQueryFnData = unknown> = (
export type GetPreviousPageParamFunction<TPageParam, TQueryFnData = unknown> = (
 firstPage: TQueryFnData,
 allPages: TQueryFnData[],
) => unknown
) => TPageParam | undefined

export type GetNextPageParamFunction<TQueryFnData = unknown> = (
export type GetNextPageParamFunction<TPageParam, TQueryFnData = unknown> = (
 lastPage: TQueryFnData,
 allPages: TQueryFnData[],
) => unknown
) => TPageParam | undefined

export interface InfiniteData<TData> {
 pages: TData[]
Expand All@@ -76,6 +83,7 @@ export interface QueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
> {
 /**
 * If `false`, failed queries will not retry by default.
Expand All@@ -87,7 +95,7 @@ export interface QueryOptions<
 retryDelay?: RetryDelayValue<TError>
 networkMode?: NetworkMode
 gcTime?: number
 queryFn?: QueryFunction<TQueryFnData, TQueryKey>
 queryFn?: QueryFunction<TQueryFnData, TQueryKey, TPageParam>
 queryHash?: string
 queryKey?: TQueryKey
 queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>
Expand All@@ -114,22 +122,24 @@ export interface QueryOptions<
 maxPages?: number
}

export interface DefaultPageParam {
 defaultPageParam: unknown
export interface DefaultPageParam<TPageParam = unknown> {
 defaultPageParam: TPageParam
}

export interface InfiniteQueryOptions<TQueryFnData = unknown>
 extends DefaultPageParam {
export interface InfiniteQueryOptions<
 TQueryFnData = unknown,
 TPageParam = unknown,
> extends DefaultPageParam<TPageParam> {
 /**
 * This function can be set to automatically get the previous cursor for infinite queries.
 * The result will also be used to determine the value of `hasPreviousPage`.
 */
 getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>
 getPreviousPageParam?: GetPreviousPageParamFunction<TPageParam, TQueryFnData>
 /**
 * This function can be set to automatically get the next cursor for infinite queries.
 * The result will also be used to determine the value of `hasNextPage`.
 */
 getNextPageParam: GetNextPageParamFunction<TQueryFnData>
 getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>
}

export type ThrowErrors<
Expand All@@ -150,7 +160,14 @@ export interface QueryObserverOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
> extends QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey> {
 TPageParam = never,
> extends QueryOptions<
 TQueryFnData,
 TError,
 TQueryData,
 TQueryKey,
 TPageParam
 > {
 /**
 * Set this to `false` to disable automatic refetching when the query mounts or changes query keys.
 * To refetch the query, use the `refetch` method returned from the `useQuery` instance.
Expand DownExpand Up@@ -289,14 +306,16 @@ export interface InfiniteQueryObserverOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends QueryObserverOptions<
 TQueryFnData,
 TError,
 InfiniteData<TData>,
 InfiniteData<TQueryData>,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 InfiniteQueryOptions<TQueryFnData> {}
 InfiniteQueryOptions<TQueryFnData, TPageParam> {}

export type DefaultedInfiniteQueryObserverOptions<
 TQueryFnData = unknown,
Expand All@@ -320,8 +339,9 @@ export interface FetchQueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
> extends WithRequired<
 QueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 QueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>,
 'queryKey'
 > {
 /**
Expand All@@ -336,13 +356,15 @@ export interface FetchInfiniteQueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends FetchQueryOptions<
 TQueryFnData,
 TError,
 InfiniteData<TData>,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 DefaultPageParam {}
 DefaultPageParam<TPageParam> {}

export interface ResultOptions {
 throwOnError?: boolean
Expand Down

4 changes: 3 additions & 1 deletion
packages/react-query/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,13 +41,15 @@ export interface UseInfiniteQueryOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends WithRequired<
 InfiniteQueryObserverOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryData,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 'queryKey'
 > {}
Expand Down

4 changes: 3 additions & 1 deletion
packages/react-query/src/useInfiniteQuery.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,13 +14,15 @@ export function useInfiniteQuery<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
>(
 options: UseInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryFnData,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 queryClient?: QueryClient,
): UseInfiniteQueryResult<TData, TError> {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: add PageParam typing#5005

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.

 Sign up for GitHub

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

 Merged

TkDodo
merged 6 commits into

from

Feb 19, 2023
 Merged


feat: add PageParam typing
#5005
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
024684a

feat: add PageParam typing


ecyrbe Feb 19, 2023
a844ee3

feat(infinite-query): more typing


ecyrbe Feb 19, 2023
510f331

feat(infinite-query): make pageParam never by defaukt


ecyrbe Feb 19, 2023
20bcf1f

feat(infinite-query): PageParam type unknown for infinite queries


ecyrbe Feb 19, 2023
5605b87

fix(infinite-query): fix tests


ecyrbe Feb 19, 2023
d78b0bb

feat(infinite-query): add previous end next return TPageParam type


ecyrbe Feb 19, 2023

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


10 changes: 8 additions & 2 deletions
packages/query-core/src/infiniteQueryBehavior.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type {
 InfiniteData,
 InfiniteQueryOptions,
 QueryFunctionContext,
 QueryKey,
} from './types'

export function infiniteQueryBehavior<
Expand DownExpand Up@@ -74,15 +75,20 @@ export function infiniteQueryBehavior<
 return Promise.resolve(pages)
 }

 const queryFnContext: Omit<QueryFunctionContext, 'signal'> = {
 const queryFnContext: Omit<
 QueryFunctionContext<QueryKey, unknown>,
 'signal'
 > = {
 queryKey: context.queryKey,
 pageParam: param,
 meta: context.options.meta,
 }

 addSignalProperty(queryFnContext)

 const queryFnResult = queryFn(queryFnContext as QueryFunctionContext)
 const queryFnResult = queryFn(
 queryFnContext as QueryFunctionContext<QueryKey, unknown>,
 )

 const promise = Promise.resolve(queryFnResult).then((page) =>
 buildNewPages(pages, param, page, previous),
Expand Down

1 change: 0 additions & 1 deletion
packages/query-core/src/query.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -362,7 +362,6 @@ export class Query<
 // Create query function context
 const queryFnContext: Omit<QueryFunctionContext<TQueryKey>, 'signal'> = {
 queryKey: this.queryKey,
 pageParam: undefined,
 meta: this.meta,
 }

Expand Down

37 changes: 33 additions & 4 deletions
packages/query-core/src/queryClient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -275,8 +275,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
 >(
 options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<TData> {
 const defaultedOptions = this.defaultQueryOptions(options)

Expand DownExpand Up@@ -308,8 +315,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
 >(
 options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<InfiniteData<TData>> {
 options.behavior = infiniteQueryBehavior<TQueryFnData, TError, TData>()
 return this.fetchQuery(options)
Expand All@@ -320,8 +334,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
 >(
 options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<void> {
 return this.fetchInfiniteQuery(options).then(noop).catch(noop)
 }
Expand DownExpand Up@@ -405,9 +426,17 @@ export class QueryClient {
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
 >(
 options?:
 | QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
 | QueryObserverOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryData,
 TQueryKey,
 TPageParam
 >
 | DefaultedQueryObserverOptions<
 TQueryFnData,
 TError,
Expand Down

1 change: 1 addition & 0 deletions
packages/query-core/src/tests/query.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -200,6 +200,7 @@ describe('query', () => {
 expect(queryFn).toHaveBeenCalledTimes(1)
 const args = queryFn.mock.calls[0]![0]
 expect(args).toBeDefined()
 // @ts-expect-error page param should be undefined
 expect(args.pageParam).toBeUndefined()
 expect(args.queryKey).toEqual(key)
 expect(args.signal).toBeInstanceOf(AbortSignal)
Expand Down

10 changes: 6 additions & 4 deletions
packages/query-core/src/tests/queryClient.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -565,15 +565,16 @@ describe('queryClient', () => {
 pageParams: [0],
 } as const

 const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
 const fetchFn: QueryFunction<StrictData, StrictQueryKey, number> = () =>
 Promise.resolve(data.pages[0])

 await expect(
 queryClient.fetchInfiniteQuery<
 StrictData,
 any,
 StrictData,
 StrictQueryKey
 StrictQueryKey,
 number
 >({ queryKey: key, queryFn: fetchFn, defaultPageParam: 0 }),
 ).resolves.toEqual(data)
 })
Expand DownExpand Up@@ -603,14 +604,15 @@ describe('queryClient', () => {
 type StrictQueryKey = ['strict', ...ReturnType<typeof queryKey>]
 const key: StrictQueryKey = ['strict', ...queryKey()]

 const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
 const fetchFn: QueryFunction<StrictData, StrictQueryKey, number> = () =>
 Promise.resolve('data')

 await queryClient.prefetchInfiniteQuery<
 StrictData,
 any,
 StrictData,
 StrictQueryKey
 StrictQueryKey,
 number
 >({ queryKey: key, queryFn: fetchFn, defaultPageParam: 0 })

 const result = queryClient.getQueryData(key)
Expand Down

74 changes: 48 additions & 26 deletions
packages/query-core/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,17 +22,24 @@ export type QueryKey = readonly unknown[]
export type QueryFunction<
 T = unknown,
 TQueryKey extends QueryKey = QueryKey,
> = (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>
 TPageParam = never,
> = (context: QueryFunctionContext<TQueryKey, TPageParam>) => T | Promise<T>

export interface QueryFunctionContext<
export type QueryFunctionContext<
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = any,
> {
 queryKey: TQueryKey
 signal: AbortSignal
 pageParam?: TPageParam
 meta: QueryMeta | undefined
}
 TPageParam = never,
> = [TPageParam] extends [never]
 ? {
 queryKey: TQueryKey
 signal: AbortSignal
 meta: QueryMeta | undefined
 }
 : {
 queryKey: TQueryKey
 signal: AbortSignal
 pageParam: TPageParam
 meta: QueryMeta | undefined
 }

export type InitialDataFunction<T> = () => T | undefined

Expand All@@ -50,15 +57,15 @@ export type QueryKeyHashFunction<TQueryKey extends QueryKey> = (
 queryKey: TQueryKey,
) => string

export type GetPreviousPageParamFunction<TQueryFnData = unknown> = (
export type GetPreviousPageParamFunction<TPageParam, TQueryFnData = unknown> = (
 firstPage: TQueryFnData,
 allPages: TQueryFnData[],
) => unknown
) => TPageParam | undefined

export type GetNextPageParamFunction<TQueryFnData = unknown> = (
export type GetNextPageParamFunction<TPageParam, TQueryFnData = unknown> = (
 lastPage: TQueryFnData,
 allPages: TQueryFnData[],
) => unknown
) => TPageParam | undefined

export interface InfiniteData<TData> {
 pages: TData[]
Expand All@@ -76,6 +83,7 @@ export interface QueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
> {
 /**
 * If `false`, failed queries will not retry by default.
Expand All@@ -87,7 +95,7 @@ export interface QueryOptions<
 retryDelay?: RetryDelayValue<TError>
 networkMode?: NetworkMode
 gcTime?: number
 queryFn?: QueryFunction<TQueryFnData, TQueryKey>
 queryFn?: QueryFunction<TQueryFnData, TQueryKey, TPageParam>
 queryHash?: string
 queryKey?: TQueryKey
 queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>
Expand All@@ -114,22 +122,24 @@ export interface QueryOptions<
 maxPages?: number
}

export interface DefaultPageParam {
 defaultPageParam: unknown
export interface DefaultPageParam<TPageParam = unknown> {
 defaultPageParam: TPageParam
}

export interface InfiniteQueryOptions<TQueryFnData = unknown>
 extends DefaultPageParam {
export interface InfiniteQueryOptions<
 TQueryFnData = unknown,
 TPageParam = unknown,
> extends DefaultPageParam<TPageParam> {
 /**
 * This function can be set to automatically get the previous cursor for infinite queries.
 * The result will also be used to determine the value of `hasPreviousPage`.
 */
 getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>
 getPreviousPageParam?: GetPreviousPageParamFunction<TPageParam, TQueryFnData>
 /**
 * This function can be set to automatically get the next cursor for infinite queries.
 * The result will also be used to determine the value of `hasNextPage`.
 */
 getNextPageParam: GetNextPageParamFunction<TQueryFnData>
 getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>
}

export type ThrowErrors<
Expand All@@ -150,7 +160,14 @@ export interface QueryObserverOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
> extends QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey> {
 TPageParam = never,
> extends QueryOptions<
 TQueryFnData,
 TError,
 TQueryData,
 TQueryKey,
 TPageParam
 > {
 /**
 * Set this to `false` to disable automatic refetching when the query mounts or changes query keys.
 * To refetch the query, use the `refetch` method returned from the `useQuery` instance.
Expand DownExpand Up@@ -289,14 +306,16 @@ export interface InfiniteQueryObserverOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends QueryObserverOptions<
 TQueryFnData,
 TError,
 InfiniteData<TData>,
 InfiniteData<TQueryData>,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 InfiniteQueryOptions<TQueryFnData> {}
 InfiniteQueryOptions<TQueryFnData, TPageParam> {}

export type DefaultedInfiniteQueryObserverOptions<
 TQueryFnData = unknown,
Expand All@@ -320,8 +339,9 @@ export interface FetchQueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
> extends WithRequired<
 QueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 QueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>,
 'queryKey'
 > {
 /**
Expand All@@ -336,13 +356,15 @@ export interface FetchInfiniteQueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends FetchQueryOptions<
 TQueryFnData,
 TError,
 InfiniteData<TData>,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 DefaultPageParam {}
 DefaultPageParam<TPageParam> {}

export interface ResultOptions {
 throwOnError?: boolean
Expand Down

4 changes: 3 additions & 1 deletion
packages/react-query/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,13 +41,15 @@ export interface UseInfiniteQueryOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends WithRequired<
 InfiniteQueryObserverOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryData,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 'queryKey'
 > {}
Expand Down

4 changes: 3 additions & 1 deletion
packages/react-query/src/useInfiniteQuery.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,13 +14,15 @@ export function useInfiniteQuery<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
>(
 options: UseInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryFnData,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 queryClient?: QueryClient,
): UseInfiniteQueryResult<TData, TError> {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat: add PageParam typing#5005

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.

 Sign up for GitHub

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

 Merged

TkDodo
merged 6 commits into

from

Feb 19, 2023
 Merged


feat: add PageParam typing
#5005
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
024684a

feat: add PageParam typing


ecyrbe Feb 19, 2023
a844ee3

feat(infinite-query): more typing


ecyrbe Feb 19, 2023
510f331

feat(infinite-query): make pageParam never by defaukt


ecyrbe Feb 19, 2023
20bcf1f

feat(infinite-query): PageParam type unknown for infinite queries


ecyrbe Feb 19, 2023
5605b87

fix(infinite-query): fix tests


ecyrbe Feb 19, 2023
d78b0bb

feat(infinite-query): add previous end next return TPageParam type


ecyrbe Feb 19, 2023

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


10 changes: 8 additions & 2 deletions
packages/query-core/src/infiniteQueryBehavior.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type {
 InfiniteData,
 InfiniteQueryOptions,
 QueryFunctionContext,
 QueryKey,
} from './types'

export function infiniteQueryBehavior<
Expand DownExpand Up@@ -74,15 +75,20 @@ export function infiniteQueryBehavior<
 return Promise.resolve(pages)
 }

 const queryFnContext: Omit<QueryFunctionContext, 'signal'> = {
 const queryFnContext: Omit<
 QueryFunctionContext<QueryKey, unknown>,
 'signal'
 > = {
 queryKey: context.queryKey,
 pageParam: param,
 meta: context.options.meta,
 }

 addSignalProperty(queryFnContext)

 const queryFnResult = queryFn(queryFnContext as QueryFunctionContext)
 const queryFnResult = queryFn(
 queryFnContext as QueryFunctionContext<QueryKey, unknown>,
 )

 const promise = Promise.resolve(queryFnResult).then((page) =>
 buildNewPages(pages, param, page, previous),
Expand Down

1 change: 0 additions & 1 deletion
packages/query-core/src/query.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -362,7 +362,6 @@ export class Query<
 // Create query function context
 const queryFnContext: Omit<QueryFunctionContext<TQueryKey>, 'signal'> = {
 queryKey: this.queryKey,
 pageParam: undefined,
 meta: this.meta,
 }

Expand Down

37 changes: 33 additions & 4 deletions
packages/query-core/src/queryClient.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -275,8 +275,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
 >(
 options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<TData> {
 const defaultedOptions = this.defaultQueryOptions(options)

Expand DownExpand Up@@ -308,8 +315,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
 >(
 options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<InfiniteData<TData>> {
 options.behavior = infiniteQueryBehavior<TQueryFnData, TError, TData>()
 return this.fetchQuery(options)
Expand All@@ -320,8 +334,15 @@ export class QueryClient {
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
 >(
 options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 options: FetchInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryKey,
 TPageParam
 >,
 ): Promise<void> {
 return this.fetchInfiniteQuery(options).then(noop).catch(noop)
 }
Expand DownExpand Up@@ -405,9 +426,17 @@ export class QueryClient {
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
 >(
 options?:
 | QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
 | QueryObserverOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryData,
 TQueryKey,
 TPageParam
 >
 | DefaultedQueryObserverOptions<
 TQueryFnData,
 TError,
Expand Down

1 change: 1 addition & 0 deletions
packages/query-core/src/tests/query.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -200,6 +200,7 @@ describe('query', () => {
 expect(queryFn).toHaveBeenCalledTimes(1)
 const args = queryFn.mock.calls[0]![0]
 expect(args).toBeDefined()
 // @ts-expect-error page param should be undefined
 expect(args.pageParam).toBeUndefined()
 expect(args.queryKey).toEqual(key)
 expect(args.signal).toBeInstanceOf(AbortSignal)
Expand Down

10 changes: 6 additions & 4 deletions
packages/query-core/src/tests/queryClient.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -565,15 +565,16 @@ describe('queryClient', () => {
 pageParams: [0],
 } as const

 const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
 const fetchFn: QueryFunction<StrictData, StrictQueryKey, number> = () =>
 Promise.resolve(data.pages[0])

 await expect(
 queryClient.fetchInfiniteQuery<
 StrictData,
 any,
 StrictData,
 StrictQueryKey
 StrictQueryKey,
 number
 >({ queryKey: key, queryFn: fetchFn, defaultPageParam: 0 }),
 ).resolves.toEqual(data)
 })
Expand DownExpand Up@@ -603,14 +604,15 @@ describe('queryClient', () => {
 type StrictQueryKey = ['strict', ...ReturnType<typeof queryKey>]
 const key: StrictQueryKey = ['strict', ...queryKey()]

 const fetchFn: QueryFunction<StrictData, StrictQueryKey> = () =>
 const fetchFn: QueryFunction<StrictData, StrictQueryKey, number> = () =>
 Promise.resolve('data')

 await queryClient.prefetchInfiniteQuery<
 StrictData,
 any,
 StrictData,
 StrictQueryKey
 StrictQueryKey,
 number
 >({ queryKey: key, queryFn: fetchFn, defaultPageParam: 0 })

 const result = queryClient.getQueryData(key)
Expand Down

74 changes: 48 additions & 26 deletions
packages/query-core/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,17 +22,24 @@ export type QueryKey = readonly unknown[]
export type QueryFunction<
 T = unknown,
 TQueryKey extends QueryKey = QueryKey,
> = (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>
 TPageParam = never,
> = (context: QueryFunctionContext<TQueryKey, TPageParam>) => T | Promise<T>

export interface QueryFunctionContext<
export type QueryFunctionContext<
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = any,
> {
 queryKey: TQueryKey
 signal: AbortSignal
 pageParam?: TPageParam
 meta: QueryMeta | undefined
}
 TPageParam = never,
> = [TPageParam] extends [never]
 ? {
 queryKey: TQueryKey
 signal: AbortSignal
 meta: QueryMeta | undefined
 }
 : {
 queryKey: TQueryKey
 signal: AbortSignal
 pageParam: TPageParam
 meta: QueryMeta | undefined
 }

export type InitialDataFunction<T> = () => T | undefined

Expand All@@ -50,15 +57,15 @@ export type QueryKeyHashFunction<TQueryKey extends QueryKey> = (
 queryKey: TQueryKey,
) => string

export type GetPreviousPageParamFunction<TQueryFnData = unknown> = (
export type GetPreviousPageParamFunction<TPageParam, TQueryFnData = unknown> = (
 firstPage: TQueryFnData,
 allPages: TQueryFnData[],
) => unknown
) => TPageParam | undefined

export type GetNextPageParamFunction<TQueryFnData = unknown> = (
export type GetNextPageParamFunction<TPageParam, TQueryFnData = unknown> = (
 lastPage: TQueryFnData,
 allPages: TQueryFnData[],
) => unknown
) => TPageParam | undefined

export interface InfiniteData<TData> {
 pages: TData[]
Expand All@@ -76,6 +83,7 @@ export interface QueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
> {
 /**
 * If `false`, failed queries will not retry by default.
Expand All@@ -87,7 +95,7 @@ export interface QueryOptions<
 retryDelay?: RetryDelayValue<TError>
 networkMode?: NetworkMode
 gcTime?: number
 queryFn?: QueryFunction<TQueryFnData, TQueryKey>
 queryFn?: QueryFunction<TQueryFnData, TQueryKey, TPageParam>
 queryHash?: string
 queryKey?: TQueryKey
 queryKeyHashFn?: QueryKeyHashFunction<TQueryKey>
Expand All@@ -114,22 +122,24 @@ export interface QueryOptions<
 maxPages?: number
}

export interface DefaultPageParam {
 defaultPageParam: unknown
export interface DefaultPageParam<TPageParam = unknown> {
 defaultPageParam: TPageParam
}

export interface InfiniteQueryOptions<TQueryFnData = unknown>
 extends DefaultPageParam {
export interface InfiniteQueryOptions<
 TQueryFnData = unknown,
 TPageParam = unknown,
> extends DefaultPageParam<TPageParam> {
 /**
 * This function can be set to automatically get the previous cursor for infinite queries.
 * The result will also be used to determine the value of `hasPreviousPage`.
 */
 getPreviousPageParam?: GetPreviousPageParamFunction<TQueryFnData>
 getPreviousPageParam?: GetPreviousPageParamFunction<TPageParam, TQueryFnData>
 /**
 * This function can be set to automatically get the next cursor for infinite queries.
 * The result will also be used to determine the value of `hasNextPage`.
 */
 getNextPageParam: GetNextPageParamFunction<TQueryFnData>
 getNextPageParam: GetNextPageParamFunction<TPageParam, TQueryFnData>
}

export type ThrowErrors<
Expand All@@ -150,7 +160,14 @@ export interface QueryObserverOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
> extends QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey> {
 TPageParam = never,
> extends QueryOptions<
 TQueryFnData,
 TError,
 TQueryData,
 TQueryKey,
 TPageParam
 > {
 /**
 * Set this to `false` to disable automatic refetching when the query mounts or changes query keys.
 * To refetch the query, use the `refetch` method returned from the `useQuery` instance.
Expand DownExpand Up@@ -289,14 +306,16 @@ export interface InfiniteQueryObserverOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends QueryObserverOptions<
 TQueryFnData,
 TError,
 InfiniteData<TData>,
 InfiniteData<TQueryData>,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 InfiniteQueryOptions<TQueryFnData> {}
 InfiniteQueryOptions<TQueryFnData, TPageParam> {}

export type DefaultedInfiniteQueryObserverOptions<
 TQueryFnData = unknown,
Expand All@@ -320,8 +339,9 @@ export interface FetchQueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = never,
> extends WithRequired<
 QueryOptions<TQueryFnData, TError, TData, TQueryKey>,
 QueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>,
 'queryKey'
 > {
 /**
Expand All@@ -336,13 +356,15 @@ export interface FetchInfiniteQueryOptions<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends FetchQueryOptions<
 TQueryFnData,
 TError,
 InfiniteData<TData>,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 DefaultPageParam {}
 DefaultPageParam<TPageParam> {}

export interface ResultOptions {
 throwOnError?: boolean
Expand Down

4 changes: 3 additions & 1 deletion
packages/react-query/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,13 +41,15 @@ export interface UseInfiniteQueryOptions<
 TData = TQueryFnData,
 TQueryData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
> extends WithRequired<
 InfiniteQueryObserverOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryData,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 'queryKey'
 > {}
Expand Down

4 changes: 3 additions & 1 deletion
packages/react-query/src/useInfiniteQuery.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,13 +14,15 @@ export function useInfiniteQuery<
 TError = RegisteredError,
 TData = TQueryFnData,
 TQueryKey extends QueryKey = QueryKey,
 TPageParam = unknown,
>(
 options: UseInfiniteQueryOptions<
 TQueryFnData,
 TError,
 TData,
 TQueryFnData,
 TQueryKey
 TQueryKey,
 TPageParam
 >,
 queryClient?: QueryClient,
): UseInfiniteQueryResult<TData, TError> {
Expand Down
Loading