[Feature Request] Add `queryOptions` function

[ylc395]

This helper function's document is here:
https://tanstack.com/query/latest/docs/framework/react/reference/queryOptions#queryoptions

Detail:
https://tkdodo.eu/blog/the-query-options-api

In official packages, this function is exported from adaptors package, like this:
https://github.com/TanStack/query/blob/3104854c1c8fff050daf031f9eeacbbc2acb4fba/packages/react-query/src/queryOptions.ts#L62

Maybe we can add this function in this repo, too.

[js2me]

Hello @ylc395 ! Thanks for this issue, I need to research for what is needed this function.
Can we you this from query core package ?

[js2me]

@ylc395 I'll try to add this in next minor release

[snovik]

Hello. are queryoptions planned to be added?
I think can add () => QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> to the constructor, this will allow to pass tanstack/queryOptions as it is.

example constructor:

    constructor(
        queryClient: QueryClient,
        queryOptions: () => QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
    )

[js2me]

Hello @snovik , thanks for your message.
Can you explain which problem is solving this solution ?

[snovik]

This solution will allow queryOptions to be transmitted as is. This is a standard mechanism from tanstack.
https://tanstack.com/query/latest/docs/framework/react/reference/queryOptions#queryoptions

If this has already been added, can you just tell me how to pass the options?

[js2me]

@snovik No, it is not currently supported, but I will add this in the next minor release. It wasn’t added earlier because it wasn’t clear to me how it should work.

[js2me]

@snovik I added overload for MobxQuery constructor and added constructor type

  constructor(
    queryClient: AnyQueryClient,
    config: QueryOptionsParams<TData, TError, TQueryKey>,
  );
  constructor(config: MobxQueryConfig<TData, TError, TQueryKey>);

Also I added overload for createQuery function from mobx-tanstack-query/preset import

export function createQuery<
  TData,
  TError = DefaultError,
  TQueryKey extends QueryKey = any,
>(
  options: QueryOptionsParams<TData, TError, TQueryKey>,
): MobxQuery<TData, TError, TQueryKey>;

export function createQuery<
  TData,
  TError = DefaultError,
  TQueryKey extends QueryKey = any,
>(
  queryFn: MobxQueryFn<TData, TError, TQueryKey>,
  params?: CreateQueryParams<TData, TError, TQueryKey>,
): MobxQuery<TData, TError, TQueryKey>;

export function createQuery<
  TData,
  TError = DefaultError,
  TQueryKey extends QueryKey = any,
>(
  queryClient: AnyQueryClient,
  options: QueryOptionsParams<TData, TError, TQueryKey>,
): MobxQuery<TData, TError, TQueryKey>;

Is that ok for you ?

[snovik]

Thanks for your work. But constructor need as this:

    constructor(
        queryClient: QueryClient,
        queryOptions: () => QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
    ) {

QueryClient - this is tanstack queryClient
QueryObserverOptions - this is options from tanstack-core.

[js2me]

@snovik QueryOptionsParams it is the save QueryObserverOptions as you see

Because of this overload of the MobxQuery will be:

constructor(
    queryClient: AnyQueryClient,
    config: () => QueryOptionsParams<TData, TError, TQueryKey>,
  );

[snovik]

Hello, thanks for the changes, version 6 get the options correctly.