Added Comments to Edge Functions

Author: samestrin

netlify/edge-functions/count.ts

@@ -2,6 +2,17 @@ import { headers } from "./headers.ts";
 import handler from "./utils.ts";
 const { fetchFromSupabase } = handler();
 
+/**
+ * Counts the number of URLs stored in Supabase.
+ *
+ * @param request - The incoming HTTP request.
+ * @returns The number of URLs in the Supabase database or an error message.
+ * @throws If an error occurs while fetching the count from Supabase.
+ *
+ * @example
+ * // Example usage
+ * curl -X GET https://your-api-url/count
+ */
 export default async (request: Request): Promise<Response> => {
   try {
     const response = await fetchFromSupabase("urls?select=id", {

netlify/edge-functions/headers.ts

@@ -1,8 +1,19 @@
+/**
+ * Common HTTP headers used in responses.
+ *
+ * @returns An object containing common HTTP headers.
+ *
+ * @example
+ * // Example usage
+ * const headers = getHeaders();
+ * fetch('/api', { headers });
+ */
+
 export const headers = {
-  'Access-Control-Allow-Origin': '*',
-  'Access-Control-Allow-Methods': '*',
-  'Access-Control-Allow-Headers': '*',
-  'Access-Control-Max-Age': '86400',
-  'Content-Type': 'application/json',
+  "Access-Control-Allow-Origin": "*",
+  "Access-Control-Allow-Methods": "*",
+  "Access-Control-Allow-Headers": "*",
+  "Access-Control-Max-Age": "86400",
+  "Content-Type": "application/json",
 };
 export default () => headers;

netlify/edge-functions/latest.ts

@@ -3,6 +3,17 @@ import handler from "./utils.ts";
 const urlBase = Deno.env.get("URL_BASE") ? Deno.env.get("URL_BASE") : "";
 const { fetchFromSupabase } = handler();
 
+/**
+ * Retrieves the latest URLs stored in Supabase.
+ *
+ * @param request - The incoming HTTP request.
+ * @returns The latest URLs from the Supabase database or an error message.
+ * @throws If an error occurs while fetching the latest URLs from Supabase.
+ *
+ * @example
+ * // Example usage
+ * curl -X GET "https://your-api-url/latest?count=5"
+ */
 export default async (request: Request): Promise<Response> => {
   console.log("here");
   try {

netlify/edge-functions/redirect.ts

@@ -1,6 +1,17 @@
 import handler from "./utils.ts";
 const { fetchFromSupabase } = handler();
 
+/**
+ * Redirects to the long URL associated with the given short URL.
+ *
+ * @param request - The incoming HTTP request.
+ * @returns A redirection response to the long URL or an error message.
+ * @throws If an error occurs while fetching the long URL from Supabase.
+ *
+ * @example
+ * // Example usage
+ * curl -X GET https://your-api-url/shortUrl
+ */
 export default async (request: Request): Promise<Response> => {
   try {
     const shortUrl = new URL(request.url).pathname.replace("/", "");

netlify/edge-functions/version.ts

@@ -1,5 +1,16 @@
 import packageJson from "../../package.json" assert { type: "json" };
 
+/**
+ * Retrieves the current version of the API.
+ *
+ * @param request - The incoming HTTP request.
+ * @returns A response containing the API version information or an error message.
+ * @throws If an error occurs while reading the package.json file.
+ *
+ * @example
+ * // Example usage
+ * curl -X GET https://your-api-url/version
+ */
 export default async (request: Request): Promise<Response> => {
   try {
     const { name, description, author, homepage, version } = packageJson;