--- id: queryOptions title: queryOptions --- ## Overview ```ts function queryOptions(options: DefinedInitialDataOptions): DefinedInitialDataOptions & object; function queryOptions(options: UnusedSkipTokenOptions): UnusedSkipTokenOptions & object; function queryOptions(options: UndefinedInitialDataOptions): UndefinedInitialDataOptions & object; ``` - [`DefinedInitialDataOptions` โ†’ `DefinedInitialDataOptions & { queryKey }`](#call-signature-1): Brands query options so the `queryKey` carries the query function data and error types across TanStack Query APIs. - [`UnusedSkipTokenOptions` โ†’ `UnusedSkipTokenOptions & { queryKey }`](#call-signature-2): Brands query options so the `queryKey` carries the query function data and error types across TanStack Query APIs. - [`UndefinedInitialDataOptions` โ†’ `UndefinedInitialDataOptions & { queryKey }`](#call-signature-3): Brands query options so the `queryKey` carries the query function data and error types across TanStack Query APIs. See also: [Parameters](#parameters-summary) ยท [Returns](#returns-summary) ## Call Signature ```ts function queryOptions(options: DefinedInitialDataOptions): DefinedInitialDataOptions & object; ``` Defined in: [packages/lit-query/src/queryOptions.ts:92](https://github.com/TanStack/query/blob/main/packages/lit-query/src/queryOptions.ts#L92) Brands query options so the `queryKey` carries the query function data and error types across TanStack Query APIs. ### Type Parameters #### TQueryFnData `TQueryFnData` = `unknown` #### TError `TError` = `Error` #### TData `TData` = `TQueryFnData` #### TQueryKey `TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] ### Parameters #### options [`DefinedInitialDataOptions`](../type-aliases/DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> Query options to preserve and brand. ### Returns [`DefinedInitialDataOptions`](../type-aliases/DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` The same options object with a typed `queryKey`. ### Example ```ts import { queryOptions } from '@tanstack/lit-query' const todosOptions = queryOptions({ queryKey: ['todos'], queryFn: fetchTodos, initialData: [], }) ``` ## Call Signature ```ts function queryOptions(options: UnusedSkipTokenOptions): UnusedSkipTokenOptions & object; ``` Defined in: [packages/lit-query/src/queryOptions.ts:109](https://github.com/TanStack/query/blob/main/packages/lit-query/src/queryOptions.ts#L109) Brands query options so the `queryKey` carries the query function data and error types across TanStack Query APIs. ### Type Parameters #### TQueryFnData `TQueryFnData` = `unknown` #### TError `TError` = `Error` #### TData `TData` = `TQueryFnData` #### TQueryKey `TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] ### Parameters #### options [`UnusedSkipTokenOptions`](../type-aliases/UnusedSkipTokenOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> Query options to preserve and brand. ### Returns [`UnusedSkipTokenOptions`](../type-aliases/UnusedSkipTokenOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` The same options object with a typed `queryKey`. ## Call Signature ```ts function queryOptions(options: UndefinedInitialDataOptions): UndefinedInitialDataOptions & object; ``` Defined in: [packages/lit-query/src/queryOptions.ts:126](https://github.com/TanStack/query/blob/main/packages/lit-query/src/queryOptions.ts#L126) Brands query options so the `queryKey` carries the query function data and error types across TanStack Query APIs. ### Type Parameters #### TQueryFnData `TQueryFnData` = `unknown` #### TError `TError` = `Error` #### TData `TData` = `TQueryFnData` #### TQueryKey `TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[] ### Parameters #### options [`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> Query options to preserve and brand. ### Returns [`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` The same options object with a typed `queryKey`. ## Parameters ### options [`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> Query options to preserve and brand. #### `options` properties Built from [`QueryObserverOptions`](../interfaces/QueryObserverOptions.md#properties). See the type above for what it changes. ## Returns [`UndefinedInitialDataOptions`](../type-aliases/UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` The same options object with a typed `queryKey`. ### Result properties Built from [`QueryObserverOptions`](../interfaces/QueryObserverOptions.md#properties). See the type above for what it changes.