ws-dottie/dist/apis/wsf-schedule/sailings/sailingsByRouteID.d.ts

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

import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type SailingsByRouteIDInput } from "./shared/sailings.input";
import { type Sailing } from "./shared/sailings.output";
/**
 * Metadata for the fetchSailingsByRouteID endpoint
 */
export declare const sailingsByRouteIDMeta: {
    functionName: string;
    endpoint: string;
    inputSchema: import("zod").ZodObject<{
        SchedRouteID: import("zod").ZodNumber;
    }, import("zod/v4/core").$strip>;
    outputSchema: import("zod").ZodArray<import("zod").ZodObject<{
        ScheduleID: import("zod").ZodNumber;
        SchedRouteID: import("zod").ZodNumber;
        RouteID: import("zod").ZodNumber;
        SailingID: import("zod").ZodNumber;
        SailingDescription: import("zod").ZodNullable<import("zod").ZodString>;
        SailingNotes: import("zod").ZodNullable<import("zod").ZodString>;
        DisplayColNum: import("zod").ZodNumber;
        SailingDir: import("zod").ZodUnion<readonly [import("zod").ZodLiteral<1>, import("zod").ZodLiteral<2>]>;
        DayOpDescription: import("zod").ZodNullable<import("zod").ZodString>;
        DayOpUseForHoliday: import("zod").ZodBoolean;
        ActiveDateRanges: import("zod").ZodNullable<import("zod").ZodArray<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>>>;
        Journs: import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodObject<{
            JourneyID: import("zod").ZodNumber;
            ReservationInd: import("zod").ZodBoolean;
            InternationalInd: import("zod").ZodBoolean;
            InterislandInd: import("zod").ZodBoolean;
            VesselID: import("zod").ZodNumber;
            VesselName: import("zod").ZodNullable<import("zod").ZodString>;
            VesselHandicapAccessible: import("zod").ZodBoolean;
            VesselPositionNum: import("zod").ZodNumber;
            TerminalTimes: import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodObject<{
                JourneyTerminalID: import("zod").ZodNumber;
                TerminalID: import("zod").ZodNumber;
                TerminalDescription: import("zod").ZodNullable<import("zod").ZodString>;
                TerminalBriefDescription: import("zod").ZodNullable<import("zod").ZodString>;
                Time: import("zod").ZodNullable<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>>;
                DepArrIndicator: import("zod").ZodNullable<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<1>, import("zod").ZodLiteral<2>]>>;
                IsNA: import("zod").ZodBoolean;
                Annotations: import("zod").ZodNullable<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>>>;
        }, import("zod/v4/core").$strip>>>;
    }, import("zod/v4/core").$strip>>;
    sampleParams: {
        SchedRouteID: number;
    };
    endpointDescription: string;
};
/**
 * Fetch function for retrieving active sailings for specified scheduled route
 */
export declare const fetchSailingsByRouteID: (params?: FetchFunctionParams<SailingsByRouteIDInput>) => Promise<Sailing[]>;
/**
 * React Query hook for retrieving active sailings for specified scheduled route
 */
export declare const useSailingsByRouteID: (params?: FetchFunctionParams<SailingsByRouteIDInput>, options?: QueryHookOptions<Sailing[]>) => UseQueryResult<Sailing[], Error>;
//# sourceMappingURL=sailingsByRouteID.d.ts.map