import type { DataTag, DefaultError, InitialDataFunction, NonUndefinedGuard, OmitKeyof, QueryFunction, QueryKey, QueryObserverOptions, SkipToken, } from '@tanstack/query-core' /** * Query options with `initialData` that guarantees defined query data. */ export type DefinedInitialDataOptions< TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, > = Omit< QueryObserverOptions, 'queryFn' > & { initialData: | NonUndefinedGuard | (() => NonUndefinedGuard) queryFn?: QueryFunction } /** * Query options where `queryFn` is present and not a `skipToken`. */ export type UnusedSkipTokenOptions< TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, > = OmitKeyof< QueryObserverOptions, 'queryFn' > & { queryFn?: Exclude< QueryObserverOptions< TQueryFnData, TError, TData, TQueryFnData, TQueryKey >['queryFn'], SkipToken | undefined > } /** * Query options where `initialData` can be omitted or undefined. */ export type UndefinedInitialDataOptions< TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, > = QueryObserverOptions< TQueryFnData, TError, TData, TQueryFnData, TQueryKey > & { initialData?: | undefined | InitialDataFunction> | NonUndefinedGuard } /** * Brands query options so the `queryKey` carries the query function data and * error types across TanStack Query APIs. * * @param options - Query options to preserve and brand. * @returns The same options object with a typed `queryKey`. * * @example * ```ts * import { queryOptions } from '@tanstack/lit-query' * * const todosOptions = queryOptions({ * queryKey: ['todos'], * queryFn: fetchTodos, * initialData: [], * }) * ``` */ export function queryOptions< TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, >( options: DefinedInitialDataOptions, ): DefinedInitialDataOptions & { queryKey: DataTag } /** * Brands query options so the `queryKey` carries the query function data and * error types across TanStack Query APIs. * * @param options - Query options to preserve and brand. * @returns The same options object with a typed `queryKey`. */ export function queryOptions< TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, >( options: UnusedSkipTokenOptions, ): UnusedSkipTokenOptions & { queryKey: DataTag } /** * Brands query options so the `queryKey` carries the query function data and * error types across TanStack Query APIs. * * @param options - Query options to preserve and brand. * @returns The same options object with a typed `queryKey`. */ export function queryOptions< TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, >( options: UndefinedInitialDataOptions, ): UndefinedInitialDataOptions & { queryKey: DataTag } export function queryOptions(options: unknown) { return options }