docs: Add JSDoc documentation

Author: CodeDredd

src/compression.ts

@@ -2,31 +2,56 @@ import type { H3Event } from 'h3'
 import type { RenderResponse } from './helper'
 import { compress, getAnyCompression } from './helper'
 
+/**
+ * Compresses the response with [zlib.gzip]{@link https://www.w3schools.com/nodejs/ref_zlib.asp}
+ * @param { H3Event } event - A H3 event object.
+ * @param { RenderResponse } response - A response object with body parameter.
+ * @returns { Promise<void> }
+ */
 export async function useGZipCompression(
   event: H3Event,
   response: Partial<RenderResponse>,
-) {
+): Promise<void> {
   await compress(event, response, 'gzip')
 }
 
+/**
+ * Compresses the response with [zlib.deflate]{@link https://www.w3schools.com/nodejs/ref_zlib.asp}
+ * @param { H3Event } event - A H3 event object.
+ * @param { RenderResponse } response - A response object with body parameter.
+ * @returns { Promise<void> }
+ */
 export async function useDeflateCompression(
   event: H3Event,
   response: Partial<RenderResponse>,
-) {
+): Promise<void> {
   await compress(event, response, 'deflate')
 }
 
+/**
+ * Compresses the response with [zlib.brotliCompress]{@link https://www.w3schools.com/nodejs/ref_zlib.asp}
+ * @param { H3Event } event - A H3 event object.
+ * @param { RenderResponse } response - A response object with body parameter.
+ * @returns { Promise<void> }
+ */
 export async function useBrotliCompression(
   event: H3Event,
   response: Partial<RenderResponse>,
-) {
+): Promise<void> {
   await compress(event, response, 'br')
 }
 
+/**
+ * Compresses the response with [Zlib]{@link https://www.w3schools.com/nodejs/ref_zlib.asp}
+ * by 'Accept-Encoding' header. Best is used first.
+ * @param { H3Event } event - A H3 event object.
+ * @param { RenderResponse } response - A response object with body parameter.
+ * @returns { Promise<void> }
+ */
 export async function useCompression(
   event: H3Event,
   response: Partial<RenderResponse>,
-) {
+): Promise<void> {
   const compression = getAnyCompression(event)
   if (compression)
     await compress(event, response, compression)

src/compressionStream.ts

@@ -3,8 +3,10 @@ import type { RenderResponse } from './helper'
 import { compressStream, getAnyCompression } from './helper'
 
 /**
- * Parse and validate params from event handler. Doesn't throw if validation fails.
+ * Compresses the response with
+ * [CompressionStream(gzip)]{@link https://developer.mozilla.org/en-US/docs/Web/API/CompressionStream}
  * @param event - A H3 event object.
+ * @param response - A response object with body parameter.
  */
 export async function useGZipCompressionStream(
   event: H3Event,
@@ -13,13 +15,26 @@ export async function useGZipCompressionStream(
   await compressStream(event, response, 'gzip')
 }
 
+/**
+ * Compresses the response with
+ * [CompressionStream(deflate)]{@link https://developer.mozilla.org/en-US/docs/Web/API/CompressionStream}
+ * @param event - A H3 event object.
+ * @param response - A response object with body parameter.
+ */
 export async function useDeflateCompressionStream(
   event: H3Event,
   response: Partial<RenderResponse>,
 ) {
   await compressStream(event, response, 'deflate')
 }
 
+/**
+ * Compresses the response with
+ * [CompressionStream]{@link https://developer.mozilla.org/en-US/docs/Web/API/CompressionStream}
+ * by 'Accept-Encoding' header. Best is used first.
+ * @param event - A H3 event object.
+ * @param response - A response object with body parameter.
+ */
 export async function useCompressionStream(
   event: H3Event,
   response: Partial<RenderResponse>,

src/helper.ts

@@ -9,7 +9,7 @@ import {
 } from 'h3'
 
 export interface RenderResponse {
-  body?: string | unknown
+  body: string | unknown
   statusCode: number
   statusMessage: string
   headers: Record<string, string>