ws-dottie/dist/types-D3jt2o5t.d.mts

Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration

import { UseQueryOptions, UseQueryResult } from '@tanstack/react-query';

/**
 * @fileoverview Consolidated Factory Types
 *
 * This module contains all type definitions for factory functions used in
 * endpoint creation. Types are consolidated here to simplify imports and
 * maintain consistency across the factory system.
 */

/**
 * Parameters for fetch functions created by factory.
 */
type FetchFunctionParams<TInput> = {
    /** Input parameters for endpoint */
    params?: TInput;
    /** Fetch strategy - how to fetch data (default: "native") */
    fetchMode?: "native" | "jsonp";
    /** Whether to validate input/output with Zod schemas (default: false) */
    validate?: boolean;
    /** Logging verbosity level (default: "none") */
    logMode?: "none" | "info" | "debug";
};
/**
 * Helper type to simplify query hook options.
 */
type QueryHookOptions<TData> = Omit<UseQueryOptions<TData>, "queryKey" | "queryFn">;
/**
 * Type representing the fetch function created by createFetchFunction factory.
 *
 * This type simplifies the signature in endpoint files by encapsulating
 * the full fetch function type: (params?) => Promise<O>.
 */
type FetchFactory<I, O> = (params?: FetchFunctionParams<I>) => Promise<O>;
/**
 * Type representing the hook function created by createHook factory.
 *
 * This type simplifies the signature in endpoint files by encapsulating
 * the full hook function type: (params?, options?) => UseQueryResult.
 */
type HookFactory<I, O> = (params?: FetchFunctionParams<I>, options?: QueryHookOptions<O>) => UseQueryResult<O, Error>;

export type { FetchFactory as F, HookFactory as H };