Add docs

Author: arjunkomath

src/index.ts

@@ -1,9 +1,19 @@
 import md5 from "md5";
 import qs from "qs";
 
+/**
+ * The type of capture request to perform.
+ */
 export type RequestType = "image" | "pdf" | "content" | "metadata" | "animated";
+
+/**
+ * Options that can be passed to customize the capture request.
+ */
 export type RequestOptions = Record<string, string | number | boolean>;
 
+/**
+ * Main class for interacting with the Capture.page API.
+ */
 export class Capture {
 	static API_URL = "https://cdn.capture.page";
 	static EDGE_URL = "https://edge.capture.page";
@@ -12,6 +22,13 @@ export class Capture {
 	secret: string;
 	options: { useEdge?: boolean };
 
+	/**
+	 * Creates a new Capture instance.
+	 *
+	 * @param key - Your Capture.page API key
+	 * @param secret - Your Capture.page API secret
+	 * @param options - Optional configuration
+	 */
 	constructor(key: string, secret: string, options?: { useEdge?: boolean }) {
 		this.key = key;
 		this.secret = secret;
@@ -80,26 +97,68 @@ export class Capture {
 		return `${this.options.useEdge ? Capture.EDGE_URL : Capture.API_URL}/${this.key}/${token}/${type}?${query}`;
 	}
 
+	/**
+	 * Builds a URL for capturing a screenshot image.
+	 *
+	 * @param url - The target URL to capture
+	 * @param options - Optional request parameters to customize the capture
+	 * @returns The complete API URL for the image capture request
+	 */
 	buildImageUrl(url: string, options?: RequestOptions): string {
 		return this._buildUrl("image", url, options);
 	}
 
+	/**
+	 * Builds a URL for capturing a PDF.
+	 *
+	 * @param url - The target URL to capture
+	 * @param options - Optional request parameters to customize the capture
+	 * @returns The complete API URL for the PDF capture request
+	 */
 	buildPdfUrl(url: string, options?: RequestOptions): string {
 		return this._buildUrl("pdf", url, options);
 	}
 
+	/**
+	 * Builds a URL for capturing page content (HTML and text).
+	 *
+	 * @param url - The target URL to capture
+	 * @param options - Optional request parameters to customize the capture
+	 * @returns The complete API URL for the content capture request
+	 */
 	buildContentUrl(url: string, options?: RequestOptions): string {
 		return this._buildUrl("content", url, options);
 	}
 
+	/**
+	 * Builds a URL for capturing page metadata.
+	 *
+	 * @param url - The target URL to capture
+	 * @param options - Optional request parameters to customize the capture
+	 * @returns The complete API URL for the metadata capture request
+	 */
 	buildMetadataUrl(url: string, options?: RequestOptions): string {
 		return this._buildUrl("metadata", url, options);
 	}
 
+	/**
+	 * Builds a URL for capturing an animated screenshot (GIF or video).
+	 *
+	 * @param url - The target URL to capture
+	 * @param options - Optional request parameters to customize the capture
+	 * @returns The complete API URL for the animated capture request
+	 */
 	buildAnimatedUrl(url: string, options?: RequestOptions): string {
 		return this._buildUrl("animated", url, options);
 	}
 
+	/**
+	 * Captures and fetches a screenshot image.
+	 *
+	 * @param url - The target URL to capture
+	 * @param options - Optional request parameters to customize the capture
+	 * @returns A promise that resolves to the image data as an ArrayBuffer
+	 */
 	async fetchImage(
 		url: string,
 		options?: RequestOptions,
@@ -109,19 +168,40 @@ export class Capture {
 		);
 	}
 
+	/**
+	 * Captures and fetches a PDF.
+	 *
+	 * @param url - The target URL to capture
+	 * @param options - Optional request parameters to customize the capture
+	 * @returns A promise that resolves to the PDF data as an ArrayBuffer
+	 */
 	async fetchPdf(url: string, options?: RequestOptions): Promise<ArrayBuffer> {
 		return fetch(this.buildPdfUrl(url, options)).then((res) =>
 			res.arrayBuffer(),
 		);
 	}
 
+	/**
+	 * Captures and fetches page content (HTML and text).
+	 *
+	 * @param url - The target URL to capture
+	 * @param options - Optional request parameters to customize the capture
+	 * @returns A promise that resolves to an object containing the HTML and text content
+	 */
 	async fetchContent(
 		url: string,
 		options?: RequestOptions,
 	): Promise<{ success: boolean; html: string; textContent: string }> {
 		return fetch(this.buildContentUrl(url, options)).then((res) => res.json());
 	}
 
+	/**
+	 * Captures and fetches page metadata.
+	 *
+	 * @param url - The target URL to capture
+	 * @param options - Optional request parameters to customize the capture
+	 * @returns A promise that resolves to an object containing the page metadata
+	 */
 	async fetchMetadata(
 		url: string,
 		options?: RequestOptions,
@@ -132,6 +212,13 @@ export class Capture {
 		return fetch(this.buildMetadataUrl(url, options)).then((res) => res.json());
 	}
 
+	/**
+	 * Captures and fetches an animated screenshot (GIF or video).
+	 *
+	 * @param url - The target URL to capture
+	 * @param options - Optional request parameters to customize the capture
+	 * @returns A promise that resolves to the animated content as an ArrayBuffer
+	 */
 	async fetchAnimated(
 		url: string,
 		options?: RequestOptions,