ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
31 lines • 1.28 kB
TypeScript
import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type TerminalsInput } from "./shared/terminals.input";
import { type Terminal } from "./shared/terminals.output";
/**
* Metadata for the fetchTerminals endpoint
*/
export declare const terminalsMeta: {
functionName: string;
endpoint: string;
inputSchema: import("zod").ZodObject<{
TripDate: import("zod").ZodString;
}, import("zod/v4/core").$strip>;
outputSchema: import("zod").ZodArray<import("zod").ZodObject<{
TerminalID: import("zod").ZodNumber;
Description: import("zod").ZodString;
}, import("zod/v4/core").$strip>>;
sampleParams: {
TripDate: string;
};
endpointDescription: string;
};
/**
* Fetch function for retrieving valid departing terminals for a trip date
*/
export declare const fetchTerminals: (params?: FetchFunctionParams<TerminalsInput>) => Promise<Terminal[]>;
/**
* React Query hook for retrieving valid departing terminals for a trip date
*/
export declare const useTerminals: (params?: FetchFunctionParams<TerminalsInput>, options?: QueryHookOptions<Terminal[]>) => UseQueryResult<Terminal[], Error>;
//# sourceMappingURL=terminals.d.ts.map