ws-dottie/dist/apis/wsf-vessels/vesselBasics/vesselBasics.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 VesselBasicsInput } from "./shared/vesselBasics.input";
import { type VesselBasic } from "./shared/vesselBasics.output";
/**
 * Metadata for the fetchVesselBasics endpoint
 */
export declare const vesselBasicsMeta: {
    functionName: string;
    endpoint: string;
    inputSchema: import("zod").ZodObject<{}, import("zod/v4/core").$strict>;
    outputSchema: import("zod").ZodArray<import("zod").ZodObject<{
        VesselID: import("zod").ZodNumber;
        VesselSubjectID: import("zod").ZodNumber;
        VesselName: import("zod").ZodNullable<import("zod").ZodString>;
        VesselAbbrev: import("zod").ZodNullable<import("zod").ZodString>;
        Class: import("zod").ZodNullable<import("zod").ZodObject<{
            ClassID: import("zod").ZodNumber;
            ClassSubjectID: import("zod").ZodNumber;
            ClassName: import("zod").ZodNullable<import("zod").ZodString>;
            SortSeq: import("zod").ZodNullable<import("zod").ZodNumber>;
            DrawingImg: import("zod").ZodNullable<import("zod").ZodString>;
            SilhouetteImg: import("zod").ZodNullable<import("zod").ZodString>;
            PublicDisplayName: import("zod").ZodNullable<import("zod").ZodString>;
        }, import("zod/v4/core").$strip>>;
        Status: import("zod").ZodNullable<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<1>, import("zod").ZodLiteral<2>, import("zod").ZodLiteral<3>]>>;
        OwnedByWSF: import("zod").ZodBoolean;
    }, import("zod/v4/core").$strip>>;
    sampleParams: {};
    endpointDescription: string;
};
/**
 * Fetch function for retrieving basic information for all vessels in the fleet
 */
export declare const fetchVesselBasics: (params?: FetchFunctionParams<VesselBasicsInput>) => Promise<VesselBasic[]>;
/**
 * React Query hook for retrieving basic information for all vessels in the fleet
 */
export declare const useVesselBasics: (params?: FetchFunctionParams<VesselBasicsInput>, options?: QueryHookOptions<VesselBasic[]>) => UseQueryResult<VesselBasic[], Error>;
//# sourceMappingURL=vesselBasics.d.ts.map