ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
42 lines • 2.24 kB
TypeScript
import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type ScheduleAlertsInput } from "./shared/scheduleAlerts.input";
import { type AlertDetail } from "./shared/scheduleAlerts.output";
/**
* Metadata for the fetchScheduleAlerts endpoint
*/
export declare const scheduleAlertsMeta: {
functionName: string;
endpoint: string;
inputSchema: import("zod").ZodObject<{}, import("zod/v4/core").$strip>;
outputSchema: import("zod").ZodArray<import("zod").ZodObject<{
BulletinID: import("zod").ZodNumber;
BulletinFlag: import("zod").ZodBoolean;
BulletinText: import("zod").ZodNullable<import("zod").ZodString>;
CommunicationFlag: import("zod").ZodBoolean;
CommunicationText: import("zod").ZodNullable<import("zod").ZodString>;
RouteAlertFlag: import("zod").ZodBoolean;
RouteAlertText: import("zod").ZodNullable<import("zod").ZodString>;
HomepageAlertText: import("zod").ZodNullable<import("zod").ZodString>;
PublishDate: import("zod").ZodNullable<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>>;
DisruptionDescription: import("zod").ZodNullable<import("zod").ZodString>;
AllRoutesFlag: import("zod").ZodBoolean;
SortSeq: import("zod").ZodNumber;
AlertTypeID: import("zod").ZodNumber;
AlertType: import("zod").ZodString;
AlertFullTitle: import("zod").ZodString;
AffectedRouteIDs: import("zod").ZodArray<import("zod").ZodNumber>;
IVRText: import("zod").ZodNullable<import("zod").ZodString>;
}, import("zod/v4/core").$strip>>;
sampleParams: {};
endpointDescription: string;
};
/**
* Fetch function for retrieving all current schedule alerts
*/
export declare const fetchScheduleAlerts: (params?: FetchFunctionParams<ScheduleAlertsInput>) => Promise<AlertDetail[]>;
/**
* React Query hook for retrieving all current schedule alerts
*/
export declare const useScheduleAlerts: (params?: FetchFunctionParams<ScheduleAlertsInput>, options?: QueryHookOptions<AlertDetail[]>) => UseQueryResult<AlertDetail[], Error>;
//# sourceMappingURL=scheduleAlerts.d.ts.map