ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
61 lines • 3.44 kB
TypeScript
import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type VesselStatsInput } from "./shared/vesselStats.input";
import { type VesselStat } from "./shared/vesselStats.output";
/**
* Metadata for the fetchVesselStats endpoint
*/
export declare const vesselStatsMeta: {
functionName: string;
endpoint: string;
inputSchema: import("zod").ZodObject<{}, import("zod/v4/core").$strict>;
outputSchema: import("zod").ZodArray<import("zod").ZodObject<{
VesselID: import("zod").ZodNumber;
VesselSubjectID: import("zod").ZodNumber;
VesselName: import("zod").ZodNullable<import("zod").ZodString>;
VesselAbbrev: import("zod").ZodNullable<import("zod").ZodString>;
Class: import("zod").ZodNullable<import("zod").ZodObject<{
ClassID: import("zod").ZodNumber;
ClassSubjectID: import("zod").ZodNumber;
ClassName: import("zod").ZodNullable<import("zod").ZodString>;
SortSeq: import("zod").ZodNullable<import("zod").ZodNumber>;
DrawingImg: import("zod").ZodNullable<import("zod").ZodString>;
SilhouetteImg: import("zod").ZodNullable<import("zod").ZodString>;
PublicDisplayName: import("zod").ZodNullable<import("zod").ZodString>;
}, import("zod/v4/core").$strip>>;
VesselNameDesc: import("zod").ZodString;
VesselHistory: import("zod").ZodNullable<import("zod").ZodString>;
Beam: import("zod").ZodString;
CityBuilt: import("zod").ZodString;
SpeedInKnots: import("zod").ZodNullable<import("zod").ZodNumber>;
Draft: import("zod").ZodString;
EngineCount: import("zod").ZodNullable<import("zod").ZodNumber>;
Horsepower: import("zod").ZodNullable<import("zod").ZodNumber>;
Length: import("zod").ZodString;
MaxPassengerCount: import("zod").ZodNullable<import("zod").ZodNumber>;
PassengerOnly: import("zod").ZodBoolean;
FastFerry: import("zod").ZodBoolean;
PropulsionInfo: import("zod").ZodString;
TallDeckClearance: import("zod").ZodNullable<import("zod").ZodNumber>;
RegDeckSpace: import("zod").ZodNullable<import("zod").ZodNumber>;
TallDeckSpace: import("zod").ZodNullable<import("zod").ZodNumber>;
Tonnage: import("zod").ZodNullable<import("zod").ZodNumber>;
Displacement: import("zod").ZodNullable<import("zod").ZodNumber>;
YearBuilt: import("zod").ZodNullable<import("zod").ZodNumber>;
YearRebuilt: import("zod").ZodNullable<import("zod").ZodNumber>;
VesselDrawingImg: import("zod").ZodNullable<import("zod").ZodString>;
SolasCertified: import("zod").ZodBoolean;
MaxPassengerCountForInternational: import("zod").ZodNullable<import("zod").ZodNumber>;
}, import("zod/v4/core").$strip>>;
sampleParams: {};
endpointDescription: string;
};
/**
* Fetch function for retrieving technical specifications for all vessels
*/
export declare const fetchVesselStats: (params?: FetchFunctionParams<VesselStatsInput>) => Promise<VesselStat[]>;
/**
* React Query hook for retrieving technical specifications for all vessels
*/
export declare const useVesselStats: (params?: FetchFunctionParams<VesselStatsInput>, options?: QueryHookOptions<VesselStat[]>) => UseQueryResult<VesselStat[], Error>;
//# sourceMappingURL=vesselStats.d.ts.map