Add documentation

Author: surol

src/handler.ts

@@ -12,6 +12,7 @@ import { IncomingMessage, ServerResponse } from 'http';
  *
  * The handler may be asynchronous.
  *
+ * @category Core
  * @typeparam TCtx  A type of HTTP request processing context this handler expects.
  */
 export type HatsyHandler<TCtx extends HatsyRequestContext = HatsyRequestContext> =
@@ -35,6 +36,8 @@ export type HatsyHandler<TCtx extends HatsyRequestContext = HatsyRequestContext>
  * A context instance is immutable. It can be {@link HatsyRequestContext.Modifications modified} or even
  * {@link HatsyRequestContext.Extensions extended} when delegating request processing to the [[next]] handler
  * by creating another context based on original one.
+ *
+ * @category Core
  */
 export interface HatsyRequestContext {
 
@@ -120,6 +123,7 @@ export namespace HatsyRequestContext {
  * It iterates over the given handlers in order and delegates the request processing to them. And stops when
  * either response is written, an error thrown, or there is no more handlers.
  *
+ * @category Core
  * @typeparam TCtx  A type of HTTP request processing context the `handlers` expect.
  * @param handlers  Either single HTTP request handler or iterable of HTTP request handlers to delegate request
  * processing to.

src/handlers/render-error.ts

@@ -11,6 +11,8 @@ import { hatsyRenderHtml } from './render-html';
  *
  * This context is created once error is thrown by one of the handlers before passing it to
  * {@link HatsyConfig.errorHandler error handler}.
+ *
+ * @category Core
  */
 export interface HatsyErrorContext extends HatsyRequestContext {
 
@@ -26,6 +28,7 @@ export interface HatsyErrorContext extends HatsyRequestContext {
  *
  * Threats {@link HatsyHttpError HTTP status error} as HTTP status code to set for error page.
  *
+ * @category Core
  * @param context  HTTP processing error context.
  *
  * @returns New HTTP request handler.

src/handlers/render-html.ts

@@ -4,6 +4,14 @@
  */
 import { HatsyHandler, HatsyRequestContext } from '../handler';
 
+/**
+ * Builds HTTP request handler that renders provided HTML on response.
+ *
+ * @category Core
+ * @param html  HTML text to render or its promise.
+ *
+ * @returns HTTP request handler.
+ */
 export function hatsyRenderHtml(html: string | PromiseLike<string>): HatsyHandler {
   return async ({ response }: HatsyRequestContext): Promise<void> => {
 

src/handlers/render-json.ts

@@ -4,7 +4,15 @@
  */
 import { HatsyHandler, HatsyRequestContext } from '../handler';
 
-export function hatsyRenderJson<T>(value: T | PromiseLike<T>): HatsyHandler {
+/**
+ * Builds HTTP request handler that renders the given value as JSON on response.
+ *
+ * @category Core
+ * @param value  A value to render or its promise.
+ *
+ * @returns HTTP request handler.
+ */
+export function hatsyRenderJson(value: any | PromiseLike<any>): HatsyHandler {
   return async ({ response }: HatsyRequestContext): Promise<void> => {
 
     const content = await value;

src/http-error.ts

@@ -8,6 +8,7 @@
  * {@link HatsyHandler HTTP handlers} may raise this error. The {@link hatsyRenderError} handler would render
  * corresponding error page then.
  *
+ * @category Core
  * @see {@link HatsyConfig.ignoreErrors}
  */
 export class HatsyHttpError extends Error {

src/listener.ts

@@ -9,6 +9,8 @@ import { HatsyHttpError } from './http-error';
 
 /**
  * Hatsy configuration.
+ *
+ * @category Core
  */
 export interface HatsyConfig {
 
@@ -48,6 +50,7 @@ export interface HatsyConfig {
 /**
  * Creates Node.js HTTP request listener by Hatsy HTTP handler(s).
  *
+ * @category Core
  * @param handlers  Either single HTTP request handler or iterable of HTTP request handlers to delegate request
  * processing to.
  * @param config  Hatsy configuration.

typedoc.json

@@ -1,6 +1,6 @@
 {
   "categorizeByGroup": true,
-  "categoryOrder": ["Core", "State Tracking", "Value Tracking", "DOM Events", "*"],
+  "categoryOrder": ["Core", "Routing", "*"],
   "exclude": [
     "**/index.ts",
     "**/cli/**/*.ts",
@@ -10,7 +10,7 @@
   ],
   "excludeNotExported": true,
   "mode": "modules",
-  "name": "Functional Event Processor",
+  "name": "Hatsy",
   "out": "./target/typedoc",
   "tsconfig": "tsconfig.main.json"
 }