missing comments

Author: professoralex13

packages/amdb/src/api/getAmdbLayer.ts

@@ -3,6 +3,15 @@ import { isAxiosError, navigraphRequest } from "@navigraph/auth"
 import { getAmdbApiRoot } from "../constants"
 import { AmdbLayerName, AmdbResult, Projection } from "../types"
 
+/**
+ * Fetches a single layer from the AMDB for a specific airport
+ *
+ * @param options.icao - The ICAO code of the desired airport
+ * @param options.layer - The lowercase name of the desired layer
+ * @param options.projection - The desired coordinate system for the resulting geoJSON
+ * @param options.precision - Coordinates will be snapped to a grid with this spacing between lines
+ * @returns An geoJSON feature collection containing features of the desired layer
+ */
 export default async function getAmdbLayer<L extends AmdbLayerName>({
   icao,
   projection,

packages/amdb/src/api/getAmdbLayers.ts

@@ -3,6 +3,16 @@ import { isAxiosError, navigraphRequest } from "@navigraph/auth"
 import { getAmdbApiRoot } from "../constants"
 import { AmdbLayerName, AmdbResult, Projection } from "../types"
 
+/**
+ * Fetches all layers, specific layers, or all layers minus some set of layers from the AMDB for a specific airport
+ *
+ * @param options.icao - The ICAO code of the desired airport
+ * @param options.include - List of layers to include in the response. If this is not specified, all layers will be returned (minus those specified in `options.exclude`)
+ * @param options.exclude - List of layers to exclude from the response. This will only apply if `options.include` is not specified
+ * @param options.projection - The desired coordinate system for the resulting geoJSON
+ * @param options.precision - Coordinates will be snapped to a grid with this spacing between lines
+ * @returns An record mapping lowercase layer names to feature collections containing the features from that layer
+ */
 export default async function getAmdbLayers<
   I extends AmdbLayerName[] | undefined = undefined,
   E extends AmdbLayerName[] | undefined = undefined,

packages/amdb/src/api/searchAmdb.ts

@@ -1,8 +1,16 @@
 import { Logger } from "@navigraph/app"
 import { isAxiosError, navigraphRequest } from "@navigraph/auth"
 import { getAmdbApiRoot } from "../constants"
-import { AmdbSearchResult } from "../types"
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import { AerodromeReferencePoint, AmdbSearchResult } from "../types"
 
+/**
+ * Searches for airports with AMDB data based on a query string and returns some metadata about them
+ *
+ * @param query - All AMDB airports whose `idarpt`, `iata`, or `name` fields (from {@link AerodromeReferencePoint}) which **start** with this query string will be returned
+ *
+ * @returns A selection of properties from the {@link AerodromeReferencePoint} of the found airports, as well as the coordinates of said reference point
+ */
 export default async function searchAmdb(query: string) {
   const result = await navigraphRequest
     .get<AmdbSearchResult[]>(`${getAmdbApiRoot()}/search`, {

packages/amdb/src/lib/getAmdbAPI.ts

@@ -3,7 +3,7 @@ import getAmdbLayer from "../api/getAmdbLayer"
 import getAmdbLayers from "../api/getAmdbLayers"
 import searchAmdb from "../api/searchAmdb"
 
-/** Grabs a reference to an object containing available Navigraph Charts API functionality */
+/** Grabs a reference to an object containing available Navigraph AMDB API functionality */
 export const getAmdbAPI = () => {
   const app = getApp()
 

packages/amdb/src/types/index.ts

@@ -99,7 +99,13 @@ export const allLayers: AmdbLayerName[] = Object.keys(FeatureType)
 export type AmdbResult<P extends AmdbLayerName> = Pick<AmdbResultStructure, P>
 
 export enum Projection {
+  /**
+   * A version of {@link https://mathworld.wolfram.com/AzimuthalEquidistantProjection.html Azimuth Equidistant} where there aerodrome reference point is centered at (0, 0), and coordinates are specified in terms of (x, y) displacement in meters
+   */
   AzimuthalEquidistant = "NAVIGRAPH:ARP_AZEQ",
+  /**
+   * Standard coordinate system where locations are specified in decimal degrees of latitude and longitude
+   */
   Epsg4326 = "EPSG:4326",
 }