ws-dottie/dist/apis/wsf-vessels/vesselHistories/vesselHistoriesByVesselNameAndDateRange.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 VesselHistoriesByVesselNameAndDateRangeInput } from "./shared/vesselHistories.input";
import { type VesselHistory } from "./shared/vesselHistories.output";
/**
 * Metadata for the fetchVesselHistoriesByVesselNameAndDateRange endpoint
 */
export declare const vesselHistoriesByVesselNameAndDateRangeMeta: {
    functionName: string;
    endpoint: string;
    inputSchema: import("zod").ZodObject<{
        VesselName: import("zod").ZodString;
        DateStart: import("zod").ZodString;
        DateEnd: import("zod").ZodString;
    }, import("zod/v4/core").$strip>;
    outputSchema: import("zod").ZodArray<import("zod").ZodObject<{
        VesselId: import("zod").ZodNumber;
        Vessel: import("zod").ZodNullable<import("zod").ZodString>;
        Departing: import("zod").ZodNullable<import("zod").ZodString>;
        Arriving: import("zod").ZodNullable<import("zod").ZodString>;
        ScheduledDepart: import("zod").ZodNullable<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>>;
        ActualDepart: import("zod").ZodNullable<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>>;
        EstArrival: import("zod").ZodNullable<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>>;
        Date: import("zod").ZodNullable<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>>;
    }, import("zod/v4/core").$strip>>;
    sampleParams: {
        VesselName: string;
        DateStart: string;
        DateEnd: string;
    };
    endpointDescription: string;
};
/**
 * Fetch function for retrieving historical sailing records for a vessel within a date range
 */
export declare const fetchVesselHistoriesByVesselNameAndDateRange: (params?: FetchFunctionParams<VesselHistoriesByVesselNameAndDateRangeInput>) => Promise<VesselHistory[]>;
/**
 * React Query hook for retrieving historical sailing records for a vessel within a date range
 */
export declare const useVesselHistoriesByVesselNameAndDateRange: (params?: FetchFunctionParams<VesselHistoriesByVesselNameAndDateRangeInput>, options?: QueryHookOptions<VesselHistory[]>) => UseQueryResult<VesselHistory[], Error>;
//# sourceMappingURL=vesselHistoriesByVesselNameAndDateRange.d.ts.map