ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
47 lines • 2.61 kB
TypeScript
import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type VesselAccommodationsInput } from "./shared/vesselAccommodations.input";
import { type VesselAccommodation } from "./shared/vesselAccommodations.output";
/**
* Metadata for the fetchVesselAccommodations endpoint
*/
export declare const vesselAccommodationsMeta: {
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>>;
CarDeckRestroom: import("zod").ZodBoolean;
CarDeckShelter: import("zod").ZodBoolean;
Elevator: import("zod").ZodBoolean;
ADAAccessible: import("zod").ZodBoolean;
MainCabinGalley: import("zod").ZodBoolean;
MainCabinRestroom: import("zod").ZodBoolean;
PublicWifi: import("zod").ZodBoolean;
ADAInfo: import("zod").ZodNullable<import("zod").ZodString>;
AdditionalInfo: import("zod").ZodNullable<import("zod").ZodString>;
}, import("zod/v4/core").$strip>>;
sampleParams: {};
endpointDescription: string;
};
/**
* Fetch function for retrieving amenities and accessibility features for all vessels
*/
export declare const fetchVesselAccommodations: (params?: FetchFunctionParams<VesselAccommodationsInput>) => Promise<VesselAccommodation[]>;
/**
* React Query hook for retrieving amenities and accessibility features for all vessels
*/
export declare const useVesselAccommodations: (params?: FetchFunctionParams<VesselAccommodationsInput>, options?: QueryHookOptions<VesselAccommodation[]>) => UseQueryResult<VesselAccommodation[], Error>;
//# sourceMappingURL=vesselAccommodations.d.ts.map