comments

Author: professoralex13

examples/playground/src/components/map/avwx.tsx

@@ -18,18 +18,23 @@ export const weatherColors: Record<AVWXSource, string> = {
   SIGMET: "rgb(27, 136, 136)",
 }
 
+/**
+ * Handles the rendering of Aviation Weather reports to the map
+ */
 const Avwx = memo(() => {
   const weatherApi = getWeatherApi()
 
   const sources = useRecoilValue(avwxState)
 
+  // Queries reports for all of the selected AVWX layers
   const layers = useQueries({
     queries: sources.map(source => ({
       queryKey: ["avwx", source],
       queryFn: async () => [source, await weatherApi.getAvwxReports([source])] as const,
     })),
   })
 
+  // Store refs to the map layers so they can be updated based on selections
   const layersRef = useRef<Partial<Record<AVWXSource, LeafletGeoJSON>>>({})
 
   return layers.map(({ data }) => {

examples/playground/src/components/map/weatherRoute.tsx

@@ -4,6 +4,9 @@ import { Marker, Polyline, useMap } from "react-leaflet"
 import { useRecoilState } from "recoil"
 import { weatherRouteEditState, weatherRouteState } from "../../state/weather"
 
+/**
+ * Handles the creation and rendering of routes for weather queries along routes
+ */
 export default function WeatherRouteManager() {
   const map = useMap()
 
@@ -15,17 +18,20 @@ export default function WeatherRouteManager() {
 
   useEffect(() => {
     const clickCallback = (e: LeafletMouseEvent) => {
+      // If the edit process is active, append the location of any clicks to the route array
       if (editActive) {
         setRoute([...route, e.latlng])
       }
     }
 
     const mouseMoveCallback = (e: LeafletMouseEvent) => {
+      // If the edit process is active, set the nextPosition state to the lat/lng position of the mouse for an indication of where the next line will be
       if (editActive) {
         setNextPosition(e.latlng)
       }
     }
 
+    // If the edit process is not active, the nextPosition should not be rendered
     if (!editActive) {
       setNextPosition(null)
     }
@@ -41,6 +47,7 @@ export default function WeatherRouteManager() {
 
   useEffect(() => {
     const callback = (e: KeyboardEvent) => {
+      // Whenever editing is active, pressing enter should stop it
       if (e.key === "Enter" && editActive) {
         setEditActive(false)
       }

packages/weather/src/api/avwx/getAvwxReports.ts

@@ -4,6 +4,11 @@ import { FeatureCollection, Geometry } from "geojson"
 import { getAvwxApiRoot } from "../../constants"
 import { AVWXSource, AVWXSourceProperties } from "../types"
 
+/**
+ * Queries GeoJSON data for all AVWX reports currently available from the selected sources
+ * @param sources - List of sources to from which to load AVWX reports from
+ * @returns A GEOJson feature collection containing the reports
+ */
 export default async function getAvwxReports<S extends AVWXSource>(sources: S[]) {
   const result = await navigraphRequest
     .get<FeatureCollection<Geometry, AVWXSourceProperties[S]>>(`${getAvwxApiRoot()}/combined`, {

packages/weather/src/api/getReportsAlongRoute.ts

@@ -4,6 +4,12 @@ import { Position } from "geojson"
 import { getRouteApiRoot } from "../constants"
 import { Metar, Taf } from "./types"
 
+/**
+ * Queries all TAFs or METARs within a certain range of a geographic route issued within approximately the last 10 hours
+ * @param path - List of coordinates making up the query route
+ * @param type - The type of report to query, either `'metar'` or `'taf'`
+ * @returns - An array of TAF or METAR objects parsed from the raw reports using {@link https://www.npmjs.com/package/metar-taf-parser metar-taf-parser}
+ */
 export default async function getReportsAlongRoute<T extends "metar" | "taf">(
   path: Position[],
   type: T,

packages/weather/src/api/metar/getMetarAtAirport.ts

@@ -3,6 +3,11 @@ import { isAxiosError, navigraphRequest } from "@navigraph/auth"
 import { getMetarApiRoot } from "../../constants"
 import { Metar } from "../types"
 
+/**
+ * Queries the most recently issued METAR for a given airport
+ * @param icao - The ICAO code of the airport from which to load the METAR
+ * @returns - A METAR object parsed from the raw report using {@link https://www.npmjs.com/package/metar-taf-parser metar-taf-parser}
+ */
 export default async function getMetarAtAirport(icao: string) {
   const result = await navigraphRequest
     .get<Metar>(`${getMetarApiRoot()}/${icao}`)

packages/weather/src/api/metar/getMetarsAroundPoint.ts

@@ -3,6 +3,14 @@ import { isAxiosError, navigraphRequest } from "@navigraph/auth"
 import { getMetarApiRoot } from "../../constants"
 import { Metar } from "../types"
 
+/**
+ * Queries all METARs within a distance of a point issued within approximately the last 10 hours, ordered by distance from the center point
+ * @param latitude - Latitude of the center point
+ * @param longitude - longitude of the center point
+ * @param radius - Radius in **nautical miles** around the center point to search for METARs within
+ * @param limit - Maximum number of METARs to return
+ * @returns - An array of METAR objects parsed from the raw reports using {@link https://www.npmjs.com/package/metar-taf-parser metar-taf-parser}
+ */
 export default async function getMetarsAroundPoint(
   latitude: number,
   longitude: number,

packages/weather/src/api/metar/getMetarsAtAirport.ts

@@ -3,6 +3,11 @@ import { isAxiosError, navigraphRequest } from "@navigraph/auth"
 import { getMetarApiRoot } from "../../constants"
 import { Metar } from "../types"
 
+/**
+ * Queries all METARs for an airport issued within approximately the last 10 hours
+ * @param icao - The ICAO code of the airport from which to load the METARs
+ * @returns - An array of METAR objects parsed from the raw reports using {@link https://www.npmjs.com/package/metar-taf-parser metar-taf-parser}
+ */
 export default async function getMetarsAtAirport(icao: string) {
   const result = await navigraphRequest
     .get<Metar[]>(`${getMetarApiRoot()}/multi/${icao}`)

packages/weather/src/api/taf/getTafAtAirport.ts

@@ -3,6 +3,11 @@ import { isAxiosError, navigraphRequest } from "@navigraph/auth"
 import { getTafApiRoot } from "../../constants"
 import { Taf } from "../types"
 
+/**
+ * Queries the most recently issued TAF for a given airport
+ * @param icao - The ICAO code of the airport from which to load the TAF
+ * @returns - A TAF object parsed from the raw report using {@link https://www.npmjs.com/package/metar-taf-parser metar-taf-parser}
+ */
 export default async function getTafAtAirport(icao: string) {
   const result = await navigraphRequest
     .get<Taf>(`${getTafApiRoot()}/${icao}`)

packages/weather/src/api/taf/getTafsAroundPoint.ts

@@ -3,6 +3,14 @@ import { isAxiosError, navigraphRequest } from "@navigraph/auth"
 import { getTafApiRoot } from "../../constants"
 import { Taf } from "../types"
 
+/**
+ * Queries all TAFs within a distance of a point issued within approximately the last 10 hours, ordered by distance from the center point
+ * @param latitude - Latitude of the center point
+ * @param longitude - longitude of the center point
+ * @param radius - Radius in **nautical miles** around the center point to search for TAFs within
+ * @param limit - Maximum number of TAFs to return
+ * @returns - An array of TAF objects parsed from the raw reports using {@link https://www.npmjs.com/package/metar-taf-parser metar-taf-parser}
+ */
 export default async function getTafsAroundPoint(latitude: number, longitude: number, radius?: number, limit?: number) {
   const result = await navigraphRequest
     .get<Taf[]>(`${getTafApiRoot()}/around/${latitude}/${longitude}`, {

packages/weather/src/api/taf/getTafsAtAirport.ts

@@ -3,6 +3,11 @@ import { isAxiosError, navigraphRequest } from "@navigraph/auth"
 import { getTafApiRoot } from "../../constants"
 import { Taf } from "../types"
 
+/**
+ * Queries all TAFs for an airport issued within approximately the last 10 hours
+ * @param icao - The ICAO code of the airport from which to load the TAFs
+ * @returns - An array of TAF objects parsed from the raw reports using {@link https://www.npmjs.com/package/metar-taf-parser metar-taf-parser}
+ */
 export default async function getTafsAtAirport(icao: string) {
   const result = await navigraphRequest
     .get<Taf[]>(`${getTafApiRoot()}/multi/${icao}`)