ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
70 lines • 2.33 kB
JavaScript
/**
* @module WSDOT — Traffic Flow API
* @description Point-in-time traffic flow readings from WSDOT flow stations.
*
* Provides:
* - Single traffic flow by `FlowDataID`
*
* Data includes:
* - Flow station identifier, numeric flow reading (0–4), station location, region, station name, and observation time (JS Date)
*
* @functions
* - getTrafficFlowById: Returns a single traffic flow by `flowDataID`
*
* @input
* - getTrafficFlowById:
* - flowDataID: Flow data identifier
*
* @output
* - getTrafficFlowById: TrafficFlow
* - TrafficFlow fields:
* - FlowDataID: Flow data identifier (nullable)
* - FlowReadingValue: Numeric reading 0–4 (0=Unknown, 1=WideOpen, 2=Moderate, 3=Heavy, 4=StopAndGo)
* - FlowStationLocation: Location details (nullable)
* - Region: Region name (nullable)
* - StationName: Station identifier (nullable)
* - Time: Observation time (JS Date, nullable)
*
* @baseType
* - TrafficFlow: Traffic flow record
* - FlowStationLocation: Station location details
*
* @cli
* - getTrafficFlowById: node dist/cli.mjs getTrafficFlowById '{"flowDataID": 2482}'
*
* @exampleResponse
* {
* "FlowDataID": 2482,
* "FlowReadingValue": 1,
* "FlowStationLocation": {
* "Description": "Homeacres Rd",
* "Direction": "EB",
* "Latitude": 47.978415632,
* "Longitude": -122.174701738,
* "MilePost": 0.68,
* "RoadName": "002"
* },
* "Region": "Northwest",
* "StationName": "002es00068",
* "Time": "2025-09-04T00:05:22.000Z"
* }
*
* @see https://wsdot.wa.gov/traffic/api/Documentation/group___traffic_flow.html
*/
import { z } from "zod";
import { flowDataSchema, } from "@/schemas/wsdot-traffic-flow/flowData.zod";
/** Input schema for getTrafficFlowById */
const trafficFlowByIdInput = z.object({
/** Flow data identifier */
flowDataID: z.number(),
});
/** Endpoint metadata for getTrafficFlowById */
export const getTrafficFlowByIdMeta = {
id: "wsdot-traffic-flow/getTrafficFlowById",
endpoint: "/traffic/api/TrafficFlow/TrafficFlowREST.svc/GetTrafficFlowAsJson?FlowDataID={flowDataID}",
inputSchema: trafficFlowByIdInput,
outputSchema: flowDataSchema,
sampleParams: { flowDataID: 2482 },
cacheStrategy: "FREQUENT",
};
//# sourceMappingURL=getTrafficFlowById.js.map