@macalinao/grill/src/hooks/types.ts

Modern Solana development kit for React applications with automatic account batching, caching, and transaction notifications

import type { useQuery } from "@tanstack/react-query";
import type { Simplify } from "gill";
export type OmittedUseQueryFields = "queryKey" | "queryFn";

export type GillUseQueryDefaultOptions = Omit<
  Parameters<typeof useQuery>[0],
  OmittedUseQueryFields
>;

export interface GillUseRpcHook<
  TConfig,
  TOptions extends GillUseQueryDefaultOptions = GillUseQueryDefaultOptions,
> {
  /**
   * RPC configuration passed to the RPC method being called
   */
  config?: TConfig;
  /**
   * Options passed to the {@link useQuery} hook
   */
  options?: Simplify<TOptions>;
  /**
   * Signal used to abort the RPC operation
   *
   * See MDN docs for {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal | AbortSignal}
   * and {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortController | AbortController}
   */
  abortSignal?: AbortSignal;
}