Blame: docs/reference/streamedQuery.md - TanStack/query

TanStack / query UNCLAIMED

🤖 Powerful asynchronous state management, server-state utilities and data fetching for the web. TS/JS, React Query, Solid Query, Svelte Query and Vue Query.

48949 0 0 TypeScript

Normal View History Raw

feat(core): streamedQuery (#8814) * feat: streamedQuery * feat: streaming example * chore: move * chore: fix lock file * docs: streamedQuery 2025-03-18 12:09:51 +01:00			`---`
			`id: streamedQuery`
			`title: streamedQuery`
			`---`

			`streamedQuery` is a helper function to create a query function that streams data from an [AsyncIterable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncIterator). Data will be an Array of all the chunks received. The query will be in a `pending` state until the first chunk of data is received, but will go to `success` after that. The query will stay in fetchStatus `fetching` until the stream ends.

docs: fix links commit 113eb6ba963534fe80b3e96193d767bf769c8bff Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 23:16:11 2025 -0600 docs: fix: only transform generated reference commit d1d084ed9026e31ba746e1bb87d5c19183a7d148 Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 23:12:07 2025 -0600 docs: fix broken links commit 0df59ea7d8afb16be86ae917fc46900b6e999351 Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 15:54:19 2025 -0600 fix: rewrite type doc links to be directory-relative commit 81e4c71f1c9250005f164b7e585837ee0ad14e23 Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 15:14:51 2025 -0600 fix: initial fix for ./ => ../ 2025-05-24 00:47:55 -06:00			To see `streamedQuery` in action, take a look at our chat example in the [examples/react/chat directory on GitHub](https://github.com/TanStack/query/tree/main/examples/react/chat).
docs: Update streamedQuery.md 2025-04-25 10:37:57 +02:00
feat(core): streamedQuery (#8814) * feat: streamedQuery * feat: streaming example * chore: move * chore: fix lock file * docs: streamedQuery 2025-03-18 12:09:51 +01:00			```tsx
docs: Update streamedQuery.md 2025-04-25 10:37:57 +02:00			`import { experimental_streamedQuery as streamedQuery } from '@tanstack/react-query'`

feat(core): streamedQuery (#8814) * feat: streamedQuery * feat: streaming example * chore: move * chore: fix lock file * docs: streamedQuery 2025-03-18 12:09:51 +01:00			`const query = queryOptions({`
			`queryKey: ['data'],`
			`queryFn: streamedQuery({`
ref: rename queryFn to streamFn in streamedQuery (#9606) * ref: rename queryFn to streamFn in streamedQuery this avoids the weirdly double-nested queryFn naming * chore: docs * fix: docs 2025-09-04 11:19:15 +02:00			`streamFn: fetchDataInChunks,`
feat(core): streamedQuery (#8814) * feat: streamedQuery * feat: streaming example * chore: move * chore: fix lock file * docs: streamedQuery 2025-03-18 12:09:51 +01:00			`}),`
			`})`
			```

docs: Update streamedQuery.md 2025-04-25 10:37:57 +02:00			> Note: `streamedQuery` is currently marked as `experimental` because we want to gather feedback from the community. If you've tried out the API and have feedback for us, please provide it in this [GitHub discussion](https://github.com/TanStack/query/discussions/9065).

feat(core): streamedQuery (#8814) * feat: streamedQuery * feat: streaming example * chore: move * chore: fix lock file * docs: streamedQuery 2025-03-18 12:09:51 +01:00			`Options`

ref: rename queryFn to streamFn in streamedQuery (#9606) * ref: rename queryFn to streamFn in streamedQuery this avoids the weirdly double-nested queryFn naming * chore: docs * fix: docs 2025-09-04 11:19:15 +02:00			- `streamFn: (context: QueryFunctionContext) => Promise<AsyncIterable<TData>>`
feat(core): streamedQuery (#8814) * feat: streamedQuery * feat: streaming example * chore: move * chore: fix lock file * docs: streamedQuery 2025-03-18 12:09:51 +01:00			`- Required`
ref: rename queryFn to streamFn in streamedQuery (#9606) * ref: rename queryFn to streamFn in streamedQuery this avoids the weirdly double-nested queryFn naming * chore: docs * fix: docs 2025-09-04 11:19:15 +02:00			`- The function that returns a Promise of an AsyncIterable with data to stream in.`
docs: correct local relative links (#9947) * docs: correct local relative links * Update links * Slight tweaks * String 2025-12-05 22:39:25 +11:00			`- Receives a [QueryFunctionContext](../framework/react/guides/query-functions.md#queryfunctioncontext)`
ref: rename queryFn to streamFn in streamedQuery (#9606) * ref: rename queryFn to streamFn in streamedQuery this avoids the weirdly double-nested queryFn naming * chore: docs * fix: docs 2025-09-04 11:19:15 +02:00			- `refetchMode?: 'append' \| 'reset' \| 'replace'`
feat(query-core): refetchMode “replace” for streamedQuery (#9092) * refetchmode replace * feat: refetchMode replace for streamedQuery * test: should allow arrays 2025-05-01 15:24:59 +02:00			`- Optional`
			`- Defines how refetches are handled.`
			- Defaults to `'reset'`
			- When set to `'reset'`, the query will erase all data and go back into `pending` state.
			- When set to `'append'`, data will be appended to existing data.
feat: maxChunks (#9184) 2025-05-24 09:22:00 +02:00			- When set to `'replace'`, all data will be written to the cache once the stream ends.
feat(query-core): add custom reducer support to streamedQuery (#9532) * feat(query-core): add custom reducer support to streamedQuery Replace maxChunks parameter with flexible reducer function that delegates data aggregation to consumer code. This provides full control over how streamed chunks are combined into the final data structure. Add support for custom placeholderData that works seamlessly with the reducer function, allowing initialization of complex data types beyond simple arrays. https://github.com/TanStack/query/discussions/9065 BREAKING CHANGE: The maxChunks parameter has been removed from streamedQuery. Use a custom reducer function to control data aggregation behavior instead. * ci: apply automated fixes * feat(query-core): require initialValue when using custom reducer in streamedQuery Add type safety by making initialValue mandatory when providing a custom reducer function. This prevents runtime errors and ensures proper data initialization for custom data structures beyond simple arrays. Use conditional types to enforce the relationship between reducer and initialValue parameters, maintaining backward compatibility for simple array-based streaming while requiring explicit initialization for custom reducers. BREAKING CHANGE: When using a custom reducer function with streamedQuery, the initialValue parameter is now required and must be provided. * feat(query-core): require initialValue when using custom reducer in streamedQuery Add type safety by making initialValue mandatory when providing a custom reducer function. This prevents runtime errors and ensures proper data initialization for custom data structures beyond simple arrays. Use conditional types to enforce the relationship between reducer and initialValue parameters, maintaining backward compatibility for simple array-based streaming while requiring explicit initialization for custom reducers. BREAKING CHANGE: When using a custom reducer function with streamedQuery, the initialValue parameter is now required and must be provided. * feat(query-core): require initialValue when using custom reducer in streamedQuery Add type safety by making initialValue mandatory when providing a custom reducer function. This prevents runtime errors and ensures proper data initialization for custom data structures beyond simple arrays. Use conditional types to enforce the relationship between reducer and initialValue parameters, maintaining backward compatibility for simple array-based streaming while requiring explicit initialization for custom reducers. BREAKING CHANGE: When using a custom reducer function with streamedQuery, the initialValue parameter is now required and must be provided. * removed personal vscode workspace file * updated documentation * fix(docs): clarify reducer function description in streamedQuery documentation * ci: apply automated fixes * fix(tests): Code Review :: update streamedQuery tests to use correct initialValue type --------- Co-authored-by: gobbimar <marco.gobbi@adidas.com> Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> 2025-09-04 11:03:41 +02:00			- `reducer?: (accumulator: TData, chunk: TQueryFnData) => TData`
feat: maxChunks (#9184) 2025-05-24 09:22:00 +02:00			`- Optional`
feat(query-core): add custom reducer support to streamedQuery (#9532) * feat(query-core): add custom reducer support to streamedQuery Replace maxChunks parameter with flexible reducer function that delegates data aggregation to consumer code. This provides full control over how streamed chunks are combined into the final data structure. Add support for custom placeholderData that works seamlessly with the reducer function, allowing initialization of complex data types beyond simple arrays. https://github.com/TanStack/query/discussions/9065 BREAKING CHANGE: The maxChunks parameter has been removed from streamedQuery. Use a custom reducer function to control data aggregation behavior instead. * ci: apply automated fixes * feat(query-core): require initialValue when using custom reducer in streamedQuery Add type safety by making initialValue mandatory when providing a custom reducer function. This prevents runtime errors and ensures proper data initialization for custom data structures beyond simple arrays. Use conditional types to enforce the relationship between reducer and initialValue parameters, maintaining backward compatibility for simple array-based streaming while requiring explicit initialization for custom reducers. BREAKING CHANGE: When using a custom reducer function with streamedQuery, the initialValue parameter is now required and must be provided. * feat(query-core): require initialValue when using custom reducer in streamedQuery Add type safety by making initialValue mandatory when providing a custom reducer function. This prevents runtime errors and ensures proper data initialization for custom data structures beyond simple arrays. Use conditional types to enforce the relationship between reducer and initialValue parameters, maintaining backward compatibility for simple array-based streaming while requiring explicit initialization for custom reducers. BREAKING CHANGE: When using a custom reducer function with streamedQuery, the initialValue parameter is now required and must be provided. * feat(query-core): require initialValue when using custom reducer in streamedQuery Add type safety by making initialValue mandatory when providing a custom reducer function. This prevents runtime errors and ensures proper data initialization for custom data structures beyond simple arrays. Use conditional types to enforce the relationship between reducer and initialValue parameters, maintaining backward compatibility for simple array-based streaming while requiring explicit initialization for custom reducers. BREAKING CHANGE: When using a custom reducer function with streamedQuery, the initialValue parameter is now required and must be provided. * removed personal vscode workspace file * updated documentation * fix(docs): clarify reducer function description in streamedQuery documentation * ci: apply automated fixes * fix(tests): Code Review :: update streamedQuery tests to use correct initialValue type --------- Co-authored-by: gobbimar <marco.gobbi@adidas.com> Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> 2025-09-04 11:03:41 +02:00			- Reduces streamed chunks (`TQueryFnData`) into the final data shape (`TData`).
			- Default: appends each chunk to the end of the accumulator when `TData` is an array.
			- If `TData` is not an array, you must provide a custom `reducer`.
			- `initialValue?: TData = TQueryFnData`
			`- Optional`
fix(streamedQuery): fall back to initialValue when stream yields no values (#9876) * fix(streamedQuery): fall back to initialValue when stream yields no values Add failing test for empty streams and update implementation to avoid returning undefined. Includes changeset for patch release. * chore: address review nitpicks (JSDoc + test cleanup) * docs: note that initialValue is returned when the stream yields no values --------- Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc> 2025-11-16 19:19:44 +01:00			`- Defines the initial data to be used while the first chunk is being fetched, and it is also returned when the stream yields no values.`
feat(query-core): add custom reducer support to streamedQuery (#9532) * feat(query-core): add custom reducer support to streamedQuery Replace maxChunks parameter with flexible reducer function that delegates data aggregation to consumer code. This provides full control over how streamed chunks are combined into the final data structure. Add support for custom placeholderData that works seamlessly with the reducer function, allowing initialization of complex data types beyond simple arrays. https://github.com/TanStack/query/discussions/9065 BREAKING CHANGE: The maxChunks parameter has been removed from streamedQuery. Use a custom reducer function to control data aggregation behavior instead. * ci: apply automated fixes * feat(query-core): require initialValue when using custom reducer in streamedQuery Add type safety by making initialValue mandatory when providing a custom reducer function. This prevents runtime errors and ensures proper data initialization for custom data structures beyond simple arrays. Use conditional types to enforce the relationship between reducer and initialValue parameters, maintaining backward compatibility for simple array-based streaming while requiring explicit initialization for custom reducers. BREAKING CHANGE: When using a custom reducer function with streamedQuery, the initialValue parameter is now required and must be provided. * feat(query-core): require initialValue when using custom reducer in streamedQuery Add type safety by making initialValue mandatory when providing a custom reducer function. This prevents runtime errors and ensures proper data initialization for custom data structures beyond simple arrays. Use conditional types to enforce the relationship between reducer and initialValue parameters, maintaining backward compatibility for simple array-based streaming while requiring explicit initialization for custom reducers. BREAKING CHANGE: When using a custom reducer function with streamedQuery, the initialValue parameter is now required and must be provided. * feat(query-core): require initialValue when using custom reducer in streamedQuery Add type safety by making initialValue mandatory when providing a custom reducer function. This prevents runtime errors and ensures proper data initialization for custom data structures beyond simple arrays. Use conditional types to enforce the relationship between reducer and initialValue parameters, maintaining backward compatibility for simple array-based streaming while requiring explicit initialization for custom reducers. BREAKING CHANGE: When using a custom reducer function with streamedQuery, the initialValue parameter is now required and must be provided. * removed personal vscode workspace file * updated documentation * fix(docs): clarify reducer function description in streamedQuery documentation * ci: apply automated fixes * fix(tests): Code Review :: update streamedQuery tests to use correct initialValue type --------- Co-authored-by: gobbimar <marco.gobbi@adidas.com> Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> 2025-09-04 11:03:41 +02:00			- It is mandatory when custom `reducer` is provided.
			`- Defaults to an empty array.`