ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
54 lines • 3.41 kB
TypeScript
import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type VesselLocationsInput } from "./shared/vesselLocations.input";
import { type VesselLocation } from "./shared/vesselLocations.output";
/**
* Metadata for the fetchVesselLocations endpoint
*/
export declare const vesselLocationsMeta: {
functionName: string;
endpoint: string;
inputSchema: import("zod").ZodObject<{}, import("zod/v4/core").$strict>;
outputSchema: import("zod").ZodArray<import("zod").ZodObject<{
VesselID: import("zod").ZodNumber;
VesselName: import("zod").ZodNullable<import("zod").ZodString>;
Mmsi: import("zod").ZodNullable<import("zod").ZodNumber>;
DepartingTerminalID: import("zod").ZodNumber;
DepartingTerminalName: import("zod").ZodNullable<import("zod").ZodString>;
DepartingTerminalAbbrev: import("zod").ZodNullable<import("zod").ZodString>;
ArrivingTerminalID: import("zod").ZodNullable<import("zod").ZodNumber>;
ArrivingTerminalName: import("zod").ZodNullable<import("zod").ZodString>;
ArrivingTerminalAbbrev: import("zod").ZodNullable<import("zod").ZodString>;
Latitude: import("zod").ZodNumber;
Longitude: import("zod").ZodNumber;
Speed: import("zod").ZodNumber;
Heading: import("zod").ZodNumber;
InService: import("zod").ZodBoolean;
AtDock: import("zod").ZodBoolean;
LeftDock: import("zod").ZodNullable<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>>;
Eta: import("zod").ZodNullable<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>>;
EtaBasis: import("zod").ZodNullable<import("zod").ZodString>;
ScheduledDeparture: import("zod").ZodNullable<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>>;
OpRouteAbbrev: import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodString>>;
VesselPositionNum: import("zod").ZodNullable<import("zod").ZodNumber>;
SortSeq: import("zod").ZodNumber;
ManagedBy: import("zod").ZodUnion<readonly [import("zod").ZodLiteral<1>, import("zod").ZodLiteral<2>]>;
TimeStamp: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
VesselWatchShutID: import("zod").ZodNumber;
VesselWatchShutMsg: import("zod").ZodNullable<import("zod").ZodString>;
VesselWatchShutFlag: import("zod").ZodNullable<import("zod").ZodString>;
VesselWatchStatus: import("zod").ZodNullable<import("zod").ZodString>;
VesselWatchMsg: import("zod").ZodNullable<import("zod").ZodString>;
}, import("zod/v4/core").$strip>>;
sampleParams: {};
endpointDescription: string;
};
/**
* Fetch function for retrieving current locations and status for all active vessels
*/
export declare const fetchVesselLocations: (params?: FetchFunctionParams<VesselLocationsInput>) => Promise<VesselLocation[]>;
/**
* React Query hook for retrieving current locations and status for all active vessels
*/
export declare const useVesselLocations: (params?: FetchFunctionParams<VesselLocationsInput>, options?: QueryHookOptions<VesselLocation[]>) => UseQueryResult<VesselLocation[], Error>;
//# sourceMappingURL=vesselLocations.d.ts.map