TypeDoc all the thngs

src/http/kernel/module/AbstractResolvedRouteHandlerHTTPModule.ts

@@ -5,7 +5,16 @@ import {plaintext} from "../../response/StringResponseFactory";
 import {ResponseFactory} from "../../response/ResponseFactory";
 import {json} from "../../response/JSONResponseFactory";
 
+/**
+ * Base class for HTTP kernel modules that apply some response from a route handler to the request.
+ */
 export abstract class AbstractResolvedRouteHandlerHTTPModule extends HTTPKernelModule {
+    /**
+     * Given a response object, write the response to the request in the appropriate format.
+     * @param object
+     * @param request
+     * @protected
+     */
     protected async applyResponseObject(object: ResponseObject, request: Request) {
         if ( (typeof object === 'string') || (typeof object === 'number') ) {
             object = plaintext(String(object))

src/http/kernel/module/ExecuteResolvedRouteHandlerHTTPModule.ts

@@ -6,6 +6,11 @@ import {http} from "../../response/HTTPErrorResponseFactory";
 import {HTTPStatus} from "@extollo/util";
 import {AbstractResolvedRouteHandlerHTTPModule} from "./AbstractResolvedRouteHandlerHTTPModule";
 
+/**
+ * HTTP kernel module that runs the handler for the request's route.
+ *
+ * In most cases, this is the controller method defined by the route.
+ */
 export class ExecuteResolvedRouteHandlerHTTPModule extends AbstractResolvedRouteHandlerHTTPModule {
     public static register(kernel: HTTPKernel) {
         kernel.register(this).core()

src/http/kernel/module/ExecuteResolvedRoutePostflightHTTPModule.ts

@@ -5,6 +5,11 @@ import {ResponseObject} from "../../routing/Route";
 import {AbstractResolvedRouteHandlerHTTPModule} from "./AbstractResolvedRouteHandlerHTTPModule";
 import {PersistSessionHTTPModule} from "./PersistSessionHTTPModule";
 
+/**
+ * HTTP kernel module that executes the postflight handlers for the route.
+ *
+ * Usually, this is post middleware.
+ */
 export class ExecuteResolvedRoutePostflightHTTPModule extends AbstractResolvedRouteHandlerHTTPModule {
     public static register(kernel: HTTPKernel) {
         kernel.register(this).before(PersistSessionHTTPModule)

src/http/kernel/module/ExecuteResolvedRoutePreflightHTTPModule.ts

@@ -5,6 +5,11 @@ import {ActivatedRoute} from "../../routing/ActivatedRoute";
 import {ResponseObject} from "../../routing/Route";
 import {AbstractResolvedRouteHandlerHTTPModule} from "./AbstractResolvedRouteHandlerHTTPModule";
 
+/**
+ * HTTP Kernel module that executes the preflight handlers for the route.
+ *
+ * Usually, this is the pre middleware.
+ */
 export class ExecuteResolvedRoutePreflightHTTPModule extends AbstractResolvedRouteHandlerHTTPModule {
     public static register(kernel: HTTPKernel) {
         kernel.register(this).after(MountActivatedRouteHTTPModule)

src/http/kernel/module/InjectSessionHTTPModule.ts

@@ -7,6 +7,10 @@ import {SetSessionCookieHTTPModule} from "./SetSessionCookieHTTPModule";
 import {SessionFactory} from "../../session/SessionFactory";
 import {Session} from "../../session/Session";
 
+/**
+ * HTTP kernel middleware that creates the session using the configured driver
+ * and loads its data using the request's session cookie.
+ */
 @Injectable()
 export class InjectSessionHTTPModule extends HTTPKernelModule {
     public readonly executeWithBlockingWriteback = true

src/http/kernel/module/MountActivatedRouteHTTPModule.ts

@@ -6,6 +6,10 @@ import {Routing} from "../../../service/Routing";
 import {ActivatedRoute} from "../../routing/ActivatedRoute";
 import {Logging} from "../../../service/Logging";
 
+/**
+ * HTTP kernel middleware that tries to find a registered route matching the request's
+ * path and creates an ActivatedRoute instance from it.
+ */
 @Injectable()
 export class MountActivatedRouteHTTPModule extends HTTPKernelModule {
     public readonly executeWithBlockingWriteback = true

src/http/kernel/module/PersistSessionHTTPModule.ts

@@ -4,6 +4,10 @@ import {HTTPKernel} from "../HTTPKernel";
 import {Request} from "../../lifecycle/Request";
 import {Session} from "../../session/Session";
 
+/**
+ * HTTP kernel module that runs after the main logic in the request to persist
+ * the session data to the driver's backend.
+ */
 @Injectable()
 export class PersistSessionHTTPModule extends HTTPKernelModule {
     public readonly executeWithBlockingWriteback = true

src/http/kernel/module/PoweredByHeaderInjectionHTTPModule.ts

@@ -4,6 +4,9 @@ import {Injectable, Inject} from "@extollo/di"
 import {HTTPKernel} from "../HTTPKernel";
 import {Config} from "../../../service/Config";
 
+/**
+ * HTTP kernel middleware that sets the `X-Powered-By` header.
+ */
 @Injectable()
 export class PoweredByHeaderInjectionHTTPModule extends HTTPKernelModule {
     public readonly executeWithBlockingWriteback = true

src/http/kernel/module/SetSessionCookieHTTPModule.ts

@@ -5,6 +5,10 @@ import {HTTPKernel} from "../HTTPKernel";
 import {Request} from "../../lifecycle/Request";
 import {Logging} from "../../../service/Logging";
 
+/**
+ * HTTP kernel middleware that tries to look up the session ID from the request.
+ * If none exists, generates a new one and sets the cookie.
+ */
 @Injectable()
 export class SetSessionCookieHTTPModule extends HTTPKernelModule {
     public readonly executeWithBlockingWriteback = true