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.

0 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.

			```tsx
			`const query = queryOptions({`
			`queryKey: ['data'],`
			`queryFn: streamedQuery({`
			`queryFn: fetchDataInChunks,`
			`}),`
			`})`
			```

			`Options`

			- `queryFn: (context: QueryFunctionContext) => Promise<AsyncIterable<TData>>`
			`- Required`
			`- The function that returns a Promise of an AsyncIterable of data to stream in.`
			`- Receives a [QueryFunctionContext](../guides/query-functions.md#queryfunctioncontext)`
			- `refetchMode?: 'append' \| 'reset'`
			`- optional`
			- when set to `'reset'`, the query will erase all data and go back into `pending` state when a refetch occurs.
docs: typo (#8932) 2025-04-02 15:46:03 +09:00			- when set to `'append'`, data will be appended on a refetch.
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			- defaults to `'reset'`