@adonisjs/http-server 6.8.2-0 → 6.8.2-10

package/build/src/qs.js

@@ -1,4 +1,16 @@
+/*
+ * @adonisjs/http-server
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { parse, stringify } from 'qs';
+/**
+ * Query string parser used to parse and stringify query
+ * strings.
+ */
 export class Qs {
     #config;
     constructor(config) {

package/build/src/redirect.d.ts

@@ -4,15 +4,39 @@ import type { Qs } from './qs.js';
 import type { Response } from './response.js';
 import type { Router } from './router/main.js';
 import type { MakeUrlOptions } from './types/route.js';
+/**
+ * Exposes the API to construct redirect routes
+ */
 export declare class Redirect {
     #private;
     constructor(request: IncomingMessage, response: Response, router: Router, qs: Qs);
+    /**
+     * Set a custom status code.
+     */
     status(statusCode: number): this;
+    /**
+     * Clearing query string values added using the
+     * "withQs" method
+     */
     clearQs(): this;
+    /**
+     * Define query string for the redirect. Not passing
+     * any value will forward the current request query
+     * string.
+     */
     withQs(): this;
     withQs(values: Record<string, any>): this;
     withQs(name: string, value: any): this;
+    /**
+     * Redirect to the previous path.
+     */
     back(): void;
+    /**
+     * Redirect the request using a route identifier.
+     */
     toRoute(routeIdentifier: string, params?: any[] | Record<string, any>, options?: MakeUrlOptions): void;
+    /**
+     * Redirect the request using a path.
+     */
     toPath(url: string): void;
 }

package/build/src/redirect.js

@@ -1,9 +1,29 @@
+/*
+ * @adonisjs/http-server
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { parse } from 'node:url';
 import encodeUrl from 'encodeurl';
 import debug from './debug.js';
+/**
+ * Exposes the API to construct redirect routes
+ */
 export class Redirect {
+    /**
+     * A boolean to forward the existing query string
+     */
     #forwardQueryString = false;
+    /**
+     * The status code for the redirect
+     */
     #statusCode = 302;
+    /**
+     * A custom query string to forward
+     */
     #queryString = {};
     #request;
     #response;
@@ -15,6 +35,9 @@ export class Redirect {
         this.#router = router;
         this.#qs = qs;
     }
+    /**
+     * Sends response by setting require headers
+     */
     #sendResponse(url, query) {
         const stringified = this.#qs.stringify(query);
         url = stringified ? `${url}?${stringified}` : url;
@@ -24,14 +47,24 @@ export class Redirect {
         this.#response.type('text/plain; charset=utf-8');
         this.#response.send(`Redirecting to ${url}`);
     }
+    /**
+     * Returns the referrer url
+     */
     #getReferrerUrl() {
         let url = this.#request.headers['referer'] || this.#request.headers['referrer'] || '/';
         return Array.isArray(url) ? url[0] : url;
     }
+    /**
+     * Set a custom status code.
+     */
     status(statusCode) {
         this.#statusCode = statusCode;
         return this;
     }
+    /**
+     * Clearing query string values added using the
+     * "withQs" method
+     */
     clearQs() {
         this.#forwardQueryString = false;
         this.#queryString = {};
@@ -49,18 +82,33 @@ export class Redirect {
         Object.assign(this.#queryString, name);
         return this;
     }
+    /**
+     * Redirect to the previous path.
+     */
     back() {
         let query = {};
         const referrerUrl = this.#getReferrerUrl();
         const url = parse(referrerUrl);
         debug('referrer url "%s"', referrerUrl);
         debug('referrer base url "%s"', url.pathname);
+        /**
+         * Parse query string from the referrer url
+         */
         if (this.#forwardQueryString) {
             query = this.#qs.parse(url.query || '');
         }
+        /**
+         * Append custom query string
+         */
         Object.assign(query, this.#queryString);
+        /**
+         * Redirect
+         */
         this.#sendResponse(url.pathname || '', query);
     }
+    /**
+     * Redirect the request using a route identifier.
+     */
     toRoute(routeIdentifier, params, options) {
         if (options && options.qs) {
             this.withQs(options.qs);
@@ -69,12 +117,24 @@ export class Redirect {
         const url = this.#router.makeUrl(routeIdentifier, params, options);
         return this.toPath(url);
     }
+    /**
+     * Redirect the request using a path.
+     */
     toPath(url) {
         let query = {};
+        /**
+         * Extract query string from the current URL
+         */
         if (this.#forwardQueryString) {
             query = this.#qs.parse(parse(this.#request.url).query || '');
         }
+        /**
+         * Assign custom query string
+         */
         Object.assign(query, this.#queryString);
+        /**
+         * Redirect
+         */
         this.#sendResponse(url, query);
     }
 }