UNPKG

ws-dottie

Version:

Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration

38 lines 2.11 kB
import type { UseQueryResult } from "@tanstack/react-query"; import type { FetchFunctionParams, QueryHookOptions } from "../../types"; import { type TerminalBulletinsInput } from "./shared/terminalBulletins.input"; import { type TerminalBulletin } from "./shared/terminalBulletins.output"; /** * Metadata for the fetchTerminalBulletins endpoint */ export declare const terminalBulletinsMeta: { functionName: string; endpoint: string; inputSchema: import("zod").ZodObject<{}, import("zod/v4/core").$strip>; outputSchema: import("zod").ZodArray<import("zod").ZodObject<{ TerminalID: import("zod").ZodNumber; TerminalSubjectID: import("zod").ZodNumber; RegionID: import("zod").ZodNumber; TerminalName: import("zod").ZodNullable<import("zod").ZodString>; TerminalAbbrev: import("zod").ZodNullable<import("zod").ZodString>; SortSeq: import("zod").ZodNumber; Bulletins: import("zod").ZodArray<import("zod").ZodObject<{ BulletinTitle: import("zod").ZodNullable<import("zod").ZodString>; BulletinText: import("zod").ZodNullable<import("zod").ZodString>; BulletinSortSeq: import("zod").ZodNumber; BulletinLastUpdated: import("zod").ZodNullable<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>>; BulletinLastUpdatedSortable: import("zod").ZodNullable<import("zod").ZodString>; }, import("zod/v4/core").$strip>>; }, import("zod/v4/core").$strip>>; sampleParams: {}; endpointDescription: string; }; /** * Fetch function for retrieving bulletins and alerts for all terminals */ export declare const fetchTerminalBulletins: (params?: FetchFunctionParams<TerminalBulletinsInput>) => Promise<TerminalBulletin[]>; /** * React Query hook for retrieving bulletins and alerts for all terminals */ export declare const useTerminalBulletins: (params?: FetchFunctionParams<TerminalBulletinsInput>, options?: QueryHookOptions<TerminalBulletin[]>) => UseQueryResult<TerminalBulletin[], Error>; //# sourceMappingURL=terminalBulletins.d.ts.map