API Reference / @modelence/react-query / modelenceQuery

modelenceQuery<T>(methodName, args): object

Defined in: index.ts:34

Creates query options for use with TanStack Query’s useQuery hook.

​
Example

import { useQuery } from '@tanstack/react-query';
import { modelenceQuery } from '@modelence/react-query';

function MyComponent() {
  // Basic usage
  const { data } = useQuery(modelenceQuery('todo.getAll'));

  // With additional options
  const { data: todo } = useQuery({
    ...modelenceQuery('todo.getById', { id: '123' }),
    enabled: !!id,
    staleTime: 5 * 60 * 1000,
  });

  return <div>{data?.name}</div>;
}

​
Type Parameters

Type ParameterDefault typeDescription
TunknownThe expected return type of the query

​
Parameters

ParameterTypeDescription
methodNamestringThe name of the method to query
argsArgsOptional arguments to pass to the method

​
Returns

object

Query options object for TanStack Query’s useQuery

NameTypeDefined in
queryFn()() => Promise<T>index.ts:40
queryKey(string | Args)[]index.ts:39

API Reference / @modelence/react-query / modelenceQuery

modelenceQuery<T>(methodName, args): object

Defined in: index.ts:34

Creates query options for use with TanStack Query’s useQuery hook.

​
Example

import { useQuery } from '@tanstack/react-query';
import { modelenceQuery } from '@modelence/react-query';

function MyComponent() {
  // Basic usage
  const { data } = useQuery(modelenceQuery('todo.getAll'));

  // With additional options
  const { data: todo } = useQuery({
    ...modelenceQuery('todo.getById', { id: '123' }),
    enabled: !!id,
    staleTime: 5 * 60 * 1000,
  });

  return <div>{data?.name}</div>;
}

​
Type Parameters

Type ParameterDefault typeDescription
TunknownThe expected return type of the query

​
Parameters

ParameterTypeDescription
methodNamestringThe name of the method to query
argsArgsOptional arguments to pass to the method

​
Returns

object

Query options object for TanStack Query’s useQuery

NameTypeDefined in
queryFn()() => Promise<T>index.ts:40
queryKey(string | Args)[]index.ts:39