refactor: add docblocks

Author: thetutlage

factories/http_context.ts

@@ -28,6 +28,9 @@ type FactoryParameters = {
  * testing
  */
 export class HttpContextFactory {
+  /**
+   * Factory parameters for creating HTTP context instances
+   */
   #parameters: Partial<FactoryParameters> = {}
 
   /**
@@ -53,14 +56,15 @@ export class HttpContextFactory {
 
   /**
    * Merge factory params
+   * @param params - Partial factory parameters to merge
    */
   merge(params: Partial<FactoryParameters>) {
     Object.assign(this.#parameters, params)
     return this
   }
 
   /**
-   * Create request
+   * Create HTTP context instance
    */
   create() {
     return new HttpContext(

factories/http_server.ts

@@ -11,7 +11,14 @@ import getPort from 'get-port'
 import { getActiveTest } from '@japa/runner'
 import { type IncomingMessage, type Server, type ServerResponse, createServer } from 'node:http'
 
+/**
+ * HTTP server factory for testing purposes
+ */
 export const httpServer = {
+  /**
+   * Creates a new HTTP server for testing with automatic cleanup
+   * @param handler - The request handler function
+   */
   async create(handler: (req: IncomingMessage, res: ServerResponse) => any | Promise<any>) {
     const server = createServer(handler)
     const test = getActiveTest()

factories/qs_parser_factory.ts

@@ -15,6 +15,9 @@ import type { QSParserConfig } from '../src/types/qs.ts'
  * parser for testing
  */
 export class QsParserFactory {
+  /**
+   * Default configuration options for the QS parser
+   */
   #options: QSParserConfig = {
     parse: {
       depth: 5,
@@ -32,7 +35,8 @@ export class QsParserFactory {
   }
 
   /**
-   * Merge encryption factory options
+   * Merge QS parser factory options
+   * @param options - Partial options to merge with existing configuration
    */
   merge(
     options: Partial<{
@@ -46,7 +50,7 @@ export class QsParserFactory {
   }
 
   /**
-   * Create instance of the logger class
+   * Create instance of the QS parser class
    */
   create() {
     return new Qs(this.#options)

factories/request.ts

@@ -32,6 +32,9 @@ type FactoryParameters = {
  * testing
  */
 export class RequestFactory {
+  /**
+   * Factory parameters for creating request instances
+   */
   #parameters: Partial<FactoryParameters> = {}
 
   /**
@@ -68,6 +71,7 @@ export class RequestFactory {
 
   /**
    * Returns the HTTP res object
+   * @param req - The incoming message request object
    */
   #createResponse(req: IncomingMessage) {
     return this.#parameters.res || new ServerResponse(req)
@@ -83,6 +87,7 @@ export class RequestFactory {
 
   /**
    * Merge factory params
+   * @param params - Partial factory parameters to merge
    */
   merge(params: Partial<FactoryParameters>) {
     Object.assign(this.#parameters, params)

factories/response.ts

@@ -31,6 +31,9 @@ type FactoryParameters = {
  * testing
  */
 export class ResponseFactory {
+  /**
+   * Factory parameters for creating response instances
+   */
   #parameters: Partial<FactoryParameters> = {}
 
   /**
@@ -67,6 +70,7 @@ export class ResponseFactory {
 
   /**
    * Returns the HTTP res object
+   * @param req - The incoming message request object
    */
   #createResponse(req: IncomingMessage) {
     return this.#parameters.res || new ServerResponse(req)
@@ -82,6 +86,7 @@ export class ResponseFactory {
 
   /**
    * Merge factory params
+   * @param params - Partial factory parameters to merge
    */
   merge(params: Partial<FactoryParameters>) {
     Object.assign(this.#parameters, params)

factories/router.ts

@@ -25,6 +25,9 @@ type FactoryParameters = {
  * testing
  */
 export class RouterFactory {
+  /**
+   * Factory parameters for creating router instances
+   */
   #parameters: Partial<FactoryParameters> = {}
 
   /**
@@ -44,6 +47,7 @@ export class RouterFactory {
 
   /**
    * Merge factory params
+   * @param params - Partial factory parameters to merge
    */
   merge(params: Partial<FactoryParameters>) {
     Object.assign(this.#parameters, params)

factories/server_factory.ts

@@ -31,6 +31,9 @@ type FactoryParameters = {
  * testing
  */
 export class ServerFactory {
+  /**
+   * Factory parameters for creating server instances
+   */
   #parameters: Partial<FactoryParameters> = {}
 
   /**
@@ -71,6 +74,7 @@ export class ServerFactory {
 
   /**
    * Merge factory params
+   * @param params - Partial factory parameters to merge
    */
   merge(params: Partial<FactoryParameters>) {
     Object.assign(this.#parameters, params)

factories/url_builder_factory.ts

@@ -25,6 +25,9 @@ type FactoryParameters = {
  * URLBuilderFactory is used to create route and signed route helpers
  */
 export class URLBuilderFactory<Routes extends LookupList> {
+  /**
+   * Factory parameters for creating URL builder instances
+   */
   #parameters: Partial<FactoryParameters> = {}
 
   /**
@@ -44,6 +47,7 @@ export class URLBuilderFactory<Routes extends LookupList> {
 
   /**
    * Merge factory params
+   * @param params - Partial factory parameters to merge
    */
   merge(params: Partial<FactoryParameters>) {
     Object.assign(this.#parameters, params)