GET, HEAD, OPTIONS

The method allows you to execute a Queries without TanStack's QueryClient.

With baseUrl

import { requestFn } from '@openapi-qraft/react';

const result = qraft.<service>.<operation>(
  {
    parameters,
    baseUrl,
    signal,
    meta,
    queryKey,
  },
  requestFn
);

Arguments

1. • parameters: { path, query, header } | {}
     • Required, OpenAPI request parameters for the query, strictly-typed ✨
       • If operation does not require parameters, you must pass an empty object {} for strictness
     • baseUrl - Required base URL for the requestFn
     • signal - An optional AbortSignal to cancel the request
     • meta - An optional object that will be passed to the requestFn
     • queryKey: QueryKey could be provided instead of parameters
2. requestFn: RequestFn
   • Required, a function that will be used to execute the request

No baseUrl

const result = qraft.<service>.<operation>(
  {
    parameters,
    signal,
    meta,
    queryKey,
  },
  requestFn
);

Arguments

1. • parameters: { path, query, header } | {}
     • Required, OpenAPI request parameters for the query, strictly-typed ✨
       • If operation does not require parameters, you must pass an empty object {} for strictness
   • signal - An optional AbortSignal to cancel the request
   • meta - An optional object that will be passed to the requestFn
   • queryKey: QueryKey could be provided instead of parameters
2. requestFn: Omit<RequestFn, 'baseUrl'>
   • Required, a function that will be used to execute the request. Note, that baseUrl will not be provided in the requestFn.

Returns

result: Promise<T> - The result of the query execution

Examples

With baseUrl

import { requestFn } from '@openapi-qraft/react';

/**
 * Executes the request:
 * ###
 * GET /posts?limit=10
 **/
const posts = await qraft.posts.getPosts(
  {
    parameters: { query: { limit: 10 } },
    baseUrl: 'https://api.sandbox.monite.com/v1',
  },
  requestFn
);

No baseUrl

import {
  requestFn,
  type RequestFnPayload,
  type OperationSchema
} from '@openapi-qraft/react';

/**
 * Executes the request:
 * ###
 * GET /posts?limit=10
 **/
const posts = await qraft.posts.getPosts(
  {
    parameters: { query: { limit: 10 } },
  },
  customRequestFn
);

/**
 * Custom request function with the predefined base URL
 **/
const customRequestFn = async <T,>(
  requestSchema: OperationSchema,
  requestInfo: Omit<RequestFnPayload, 'baseUrl'>
): Promise<T> =>
  requestFn(requestSchema, {
    ...requestInfo,
    baseUrl: 'https://api.sandbox.monite.com/v1',
  });

With queryKey

import { requestFn } from '@openapi-qraft/react';

/**
 * Executes the request:
 * ###
 * GET /posts?limit=10
 **/
const posts = await qraft.posts.getPosts(
  {
    queryKey: qraft.posts.getPosts.getQueryKey({ query: { limit: 10 } }),
    baseUrl: 'https://api.sandbox.monite.com/v1',
  },
  requestFn
);