ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
65 lines • 4.04 kB
TypeScript
import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type TimeAdjustmentsInput } from "./shared/timeAdjustments.input";
import { type TimeAdjustment } from "./shared/timeAdjustments.output";
/**
* Metadata for the fetchTimeAdjustments endpoint
*/
export declare const timeAdjustmentsMeta: {
functionName: string;
endpoint: string;
inputSchema: import("zod").ZodObject<{}, import("zod/v4/core").$strip>;
outputSchema: import("zod").ZodArray<import("zod").ZodObject<{
ScheduleID: import("zod").ZodNumber;
SchedRouteID: import("zod").ZodNumber;
RouteID: import("zod").ZodNumber;
RouteDescription: import("zod").ZodNullable<import("zod").ZodString>;
RouteSortSeq: import("zod").ZodNumber;
SailingID: import("zod").ZodNumber;
SailingDescription: import("zod").ZodNullable<import("zod").ZodString>;
ActiveSailingDateRange: import("zod").ZodNullable<import("zod").ZodObject<{
DateFrom: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
DateThru: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
EventID: import("zod").ZodNullable<import("zod").ZodNumber>;
EventDescription: import("zod").ZodNullable<import("zod").ZodString>;
}, import("zod/v4/core").$strip>>;
SailingDir: import("zod").ZodUnion<readonly [import("zod").ZodLiteral<1>, import("zod").ZodLiteral<2>]>;
JourneyID: import("zod").ZodNumber;
VesselID: import("zod").ZodNumber;
VesselName: import("zod").ZodNullable<import("zod").ZodString>;
VesselHandicapAccessible: import("zod").ZodBoolean;
VesselPositionNum: import("zod").ZodNumber;
JourneyTerminalID: import("zod").ZodNumber;
TerminalID: import("zod").ZodNumber;
TerminalDescription: import("zod").ZodString;
TerminalBriefDescription: import("zod").ZodString;
TimeToAdj: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
AdjDateFrom: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
AdjDateThru: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
TidalAdj: import("zod").ZodBoolean;
EventID: import("zod").ZodNullable<import("zod").ZodNumber>;
EventDescription: import("zod").ZodNullable<import("zod").ZodString>;
DepArrIndicator: import("zod").ZodUnion<readonly [import("zod").ZodLiteral<1>, import("zod").ZodLiteral<2>]>;
AdjType: import("zod").ZodUnion<readonly [import("zod").ZodLiteral<1>, import("zod").ZodLiteral<2>]>;
Annotations: import("zod").ZodArray<import("zod").ZodObject<{
AnnotationID: import("zod").ZodNumber;
AnnotationText: import("zod").ZodNullable<import("zod").ZodString>;
AnnotationIVRText: import("zod").ZodNullable<import("zod").ZodString>;
AdjustedCrossingTime: import("zod").ZodNullable<import("zod").ZodNumber>;
AnnotationImg: import("zod").ZodNullable<import("zod").ZodString>;
TypeDescription: import("zod").ZodNullable<import("zod").ZodString>;
SortSeq: import("zod").ZodNumber;
}, import("zod/v4/core").$strip>>;
}, import("zod/v4/core").$strip>>;
sampleParams: {};
endpointDescription: string;
};
/**
* Fetch function for retrieving all time adjustments across all routes
*/
export declare const fetchTimeAdjustments: (params?: FetchFunctionParams<TimeAdjustmentsInput>) => Promise<TimeAdjustment[]>;
/**
* React Query hook for retrieving all time adjustments across all routes
*/
export declare const useTimeAdjustments: (params?: FetchFunctionParams<TimeAdjustmentsInput>, options?: QueryHookOptions<TimeAdjustment[]>) => UseQueryResult<TimeAdjustment[], Error>;
//# sourceMappingURL=timeAdjustments.d.ts.map