Adding Comments

Author: samestrin

netlify/edge-functions/analyze-image.ts

@@ -8,6 +8,17 @@ import {
 
 await initialize();
 
+/**
+ * Handles the image analysis request.
+ *
+ * @param request - The incoming HTTP request.
+ * @returns The HTTP response with brightness and histogram data or an error message.
+ * @throws Will throw an error if the request method is not POST or if processing fails.
+ *
+ * @example
+ * // How to call the function.
+ * fetch('/api/analyze-image', { method: 'POST', body: formData });
+ */
 export default async (request: Request) => {
   if (request.method === "POST") {
     try {

netlify/edge-functions/convert-image.ts

@@ -8,6 +8,17 @@ import {
 
 await initialize();
 
+/**
+ * Handles the image conversion request.
+ *
+ * @param request - The incoming HTTP request.
+ * @returns The HTTP response with the converted image or an error message.
+ * @throws Will throw an error if the request method is not POST or if processing fails.
+ *
+ * @example
+ * // How to call the function.
+ * fetch('/api/convert-image', { method: 'POST', body: formData });
+ */
 export default async (request: Request) => {
   if (request.method === "POST") {
     try {
@@ -66,18 +77,22 @@ export default async (request: Request) => {
   return new Response("Method Not Allowed", { status: 405 });
 };
 
-function capitalizeWords(str) {
-  // Split the string into an array of words
+/**
+ * Capitalizes the first letter of each word in a string.
+ *
+ * @param str - The string to capitalize.
+ * @returns The capitalized string.
+ *
+ * @example
+ * // How to use the function.
+ * const capitalized = capitalizeWords("example string");
+ */
+function capitalizeWords(str: string): string {
   const words = str.split(" ");
-
-  // Loop through each word and capitalize the first letter
   const capitalizedWords = words.map((word) => {
     return word.charAt(0).toUpperCase() + word.slice(1);
   });
-
-  // Join the capitalized words back into a string
   const capitalizedString = capitalizedWords.join(" ");
-
   return capitalizedString;
 }
 

netlify/edge-functions/edge-enhance.ts

@@ -10,6 +10,17 @@ import {
 
 await initialize();
 
+/**
+ * Handles the image edge enhancement request.
+ *
+ * @param request - The incoming HTTP request.
+ * @returns The HTTP response with the enhanced image or an error message.
+ * @throws Will throw an error if the request method is not POST or if processing fails.
+ *
+ * @example
+ * // How to call the function.
+ * fetch('/api/edge-enhance', { method: 'POST', body: formData });
+ */
 export default async (request: Request) => {
   if (request.method === "POST") {
     try {

netlify/edge-functions/image-dimensions.ts

@@ -1,5 +1,16 @@
 import { multiParser } from "https://deno.land/x/multiparser@0.114.0/mod.ts";
 
+/**
+ * Handles the image dimensions request.
+ *
+ * @param request - The incoming HTTP request.
+ * @returns The HTTP response with the image dimensions or an error message.
+ * @throws Will throw an error if the request method is not POST or if processing fails.
+ *
+ * @example
+ * // How to call the function.
+ * fetch('/api/image-dimensions', { method: 'POST', body: formData });
+ */
 export default async (request: Request) => {
   if (request.method === "POST") {
     try {
@@ -63,6 +74,17 @@ export default async (request: Request) => {
   return new Response("Method Not Allowed", { status: 405 });
 };
 
+/**
+ * Extracts the dimensions of a JPEG image.
+ *
+ * @param data - The image data as a Uint8Array.
+ * @returns The width and height of the image.
+ * @throws Will throw an error if the JPEG file is invalid or dimensions are not found.
+ *
+ * @example
+ * // How to use the function.
+ * const dimensions = getJpegDimensions(fileData);
+ */
 function getJpegDimensions(data: Uint8Array): {
   width: number;
   height: number;
@@ -94,6 +116,17 @@ function getJpegDimensions(data: Uint8Array): {
   throw new Error("No size information found in JPEG");
 }
 
+/**
+ * Extracts the dimensions of a PNG image.
+ *
+ * @param data - The image data as a Uint8Array.
+ * @returns The width and height of the image.
+ * @throws Will throw an error if the PNG file is invalid.
+ *
+ * @example
+ * // How to use the function.
+ * const dimensions = getPngDimensions(fileData);
+ */
 function getPngDimensions(data: Uint8Array): { width: number; height: number } {
   if (
     data[0] !== 0x89 ||
@@ -109,6 +142,17 @@ function getPngDimensions(data: Uint8Array): { width: number; height: number } {
   return { width, height };
 }
 
+/**
+ * Extracts the dimensions of a GIF image.
+ *
+ * @param data - The image data as a Uint8Array.
+ * @returns The width and height of the image.
+ * @throws Will throw an error if the GIF file is invalid.
+ *
+ * @example
+ * // How to use the function.
+ * const dimensions = getGifDimensions(fileData);
+ */
 function getGifDimensions(data: Uint8Array): { width: number; height: number } {
   if (data[0] !== 0x47 || data[1] !== 0x49 || data[2] !== 0x46) {
     throw new Error("Invalid GIF file");
@@ -119,13 +163,35 @@ function getGifDimensions(data: Uint8Array): { width: number; height: number } {
   return { width, height };
 }
 
+/**
+ * Extracts the dimensions of a BMP image.
+ *
+ * @param data - The image data as a Uint8Array.
+ * @returns The width and height of the image.
+ * @throws Will throw an error if the BMP file is invalid.
+ *
+ * @example
+ * // How to use the function.
+ * const dimensions = getBmpDimensions(fileData);
+ */
 function getBmpDimensions(data: Uint8Array): { width: number; height: number } {
   const view = new DataView(data.buffer);
   const width = view.getInt32(18, true); // Little endian
   const height = view.getInt32(22, true); // Little endian
   return { width, height };
 }
 
+/**
+ * Extracts the dimensions of a TIFF image.
+ *
+ * @param data - The image data as a Uint8Array.
+ * @returns The width and height of the image.
+ * @throws Will throw an error if the TIFF file is invalid or dimensions are not found.
+ *
+ * @example
+ * // How to use the function.
+ * const dimensions = getTiffDimensions(fileData);
+ */
 function getTiffDimensions(data: Uint8Array): {
   width: number;
   height: number;
@@ -173,6 +239,17 @@ function getTiffDimensions(data: Uint8Array): {
   return { width, height };
 }
 
+/**
+ * Extracts the dimensions of an SVG image.
+ *
+ * @param data - The image data as a Uint8Array.
+ * @returns The width and height of the image.
+ * @throws Will throw an error if the SVG file is invalid.
+ *
+ * @example
+ * // How to use the function.
+ * const dimensions = getSvgDimensions(fileData);
+ */
 function getSvgDimensions(data: Uint8Array): { width: number; height: number } {
   const decoder = new TextDecoder("utf-8");
   const svgContent = decoder.decode(data);

netlify/edge-functions/resize-image.ts

@@ -9,6 +9,17 @@ import {
 
 await initialize();
 
+/**
+ * Handles the image resize request.
+ *
+ * @param request - The incoming HTTP request.
+ * @returns The HTTP response with the resized image or an error message.
+ * @throws Will throw an error if the request method is not POST or if processing fails.
+ *
+ * @example
+ * // How to call the function.
+ * fetch('/api/resize-image', { method: 'POST', body: formData });
+ */
 export default async (request: Request) => {
   if (request.method === "POST") {
     try {