Setting up docs

.gitattributes

@@ -0,0 +1 @@
+pnpm-lock.yaml -diff

packages/little-router/package.json

@@ -27,5 +27,8 @@
     "typescript": "^5.1.3",
     "vitest": "^0.32.0"
   },
-  "sideEffects": false
+  "sideEffects": false,
+  "dependencies": {
+    "typedoc": "^0.24.8"
+  }
 }

packages/little-router/src/plugin.ts

@@ -14,13 +14,15 @@ export type PluginContext<
   readonly params: Record<string, string>;
   /**
    * This is only used for adding typing hints to requests
-   * @private */
+   *
+   * @private
+   */
   readonly __hint?: HINT;
 };
 /**
- * _hint is for giving hints to the consumer making the request
- * regarding the request init and any possible search params
- * */
+ * _hint is for giving hints to the consumer making the request regarding the
+ * request init and any possible search params
+ */
 export type Plugin<REST_ARGS extends unknown[] = unknown[]> = (
   { request, url, params }: PluginContext<any>,
   ...rest: REST_ARGS

packages/little-router/src/router.test.ts

@@ -215,8 +215,8 @@ describe("Router with plugins", () => {
     const router = Router<[string]>().get(
       "/extra-plugin",
       [extra_],
-      async ({ value }) => {
-        return ok(`Plugin: ${value}`);
+      async () => {
+        return ok(200);
       }
     );
 

packages/little-router/src/router.ts

@@ -3,6 +3,30 @@ import { HasOverlap } from "./overlap.js";
 import { Plugin, PluginContext } from "./plugin.js";
 import { FetchDefinition, Queries } from "./fetch.js";
 
+/**
+ * Returns an instance of RouteBuilder that you can use to build your routing
+ * structure.
+ *
+ * @typeParam REST_ARGS - Used to type Env and ExecutionContext from cloudflare
+ *                        workers. More info in [cloudflare workers docs]( https://developers.cloudflare.com/workers/platform/environment-variables/).
+ *
+ * The returned RouteBuilder can be build upon by using the method function,
+ * with names corresponding to http request methods.
+ *
+ * {@link Method | Available Methods}
+ *
+ * @example
+ * ```ts
+ * type Env = {
+ *   MY_ENV_VAR: string;
+ *   MY_SECRET: string;
+ *   myKVNamespace: KVNamespace;
+ * };
+ * const router = Router<[Env, ExecutionContext]>
+ * ```
+ *
+ * More on cloudflare worker types in [their documentation](https://github.com/cloudflare/workerd/tree/main/npm/workers-types#using-bindings).
+ */
 export const Router = <REST_ARGS extends unknown[] = []>(): RouteBuilder<
   REST_ARGS,
   never
@@ -202,8 +226,49 @@ export type RouteBuilder<
   REST_ARGS extends unknown[],
   ROUTES extends FetchDefinition
 > = {
-  [METHOD in Method]: RouteProxy<METHOD, ROUTES, REST_ARGS>;
-} & {
+  /**
+   * @param route - The route to match for this http method handler
+   * @param pluginArray  - A list of plugins to be applied to this route
+   * @param handler  - A function to run when the path has been matched
+   * @returns an instance of RouteBuilder
+   */
+  get: RouteProxy<"get", ROUTES, REST_ARGS>;
+  /**
+   * @param route - The route to match for this http method handler
+   * @param pluginArray  - A list of plugins to be applied to this route
+   * @param handler  - A function to run when the path has been matched
+   * @returns an instance of RouteBuilder
+   */
+  post: RouteProxy<"post", ROUTES, REST_ARGS>;
+  /**
+   * @param route - The route to match for this http method handler
+   * @param pluginArray  - A list of plugins to be applied to this route
+   * @param handler  - A function to run when the path has been matched
+   * @returns an instance of RouteBuilder
+   */
+  put: RouteProxy<"put", ROUTES, REST_ARGS>;
+  /**
+   * @param route - The route to match for this http method handler
+   * @param pluginArray  - A list of plugins to be applied to this route
+   * @param handler  - A function to run when the path has been matched
+   * @returns an instance of RouteBuilder
+   */
+  delete: RouteProxy<"delete", ROUTES, REST_ARGS>;
+  /**
+   * @param route - The route to match for this http method handler
+   * @param pluginArray  - A list of plugins to be applied to this route
+   * @param handler  - A function to run when the path has been matched
+   * @returns an instance of RouteBuilder
+   */
+  patch: RouteProxy<"patch", ROUTES, REST_ARGS>;
+  /**
+   * @param route - The route to match for this http method handler
+   * @param pluginArray  - A list of plugins to be applied to this route
+   * @param handler  - A function to run when the path has been matched
+   * @returns an instance of RouteBuilder
+   */
+  options: RouteProxy<"options", ROUTES, REST_ARGS>;
+  all: RouteProxy<"all", ROUTES, REST_ARGS>;
   handle: (
     request: Request,
     ...rest: REST_ARGS

tools/config/.eslintrc.cjs

@@ -2,9 +2,10 @@
 module.exports = {
   extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
   parser: "@typescript-eslint/parser",
-  plugins: ["@typescript-eslint"],
+  plugins: ["@typescript-eslint", "eslint-plugin-tsdoc"],
   root: true,
   rules: {
+    "tsdoc/syntax": "warn",
     "@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_" }],
     "@typescript-eslint/no-explicit-any": "off",
   },

tools/config/package.json

@@ -3,10 +3,7 @@
   "private": true,
   "version": "0.0.10",
   "description": "",
-  "files": [
-    "tsconfig.json",
-    ".eslintrc.cjs"
-  ],
+  "files": ["tsconfig.json", ".eslintrc.cjs"],
   "scripts": {},
   "keywords": [],
   "author": "",
@@ -15,13 +12,15 @@
     "@typescript-eslint/eslint-plugin": "^5.59.9",
     "@typescript-eslint/parser": "^5.59.9",
     "eslint": "^8.42.0",
+    "eslint-plugin-tsdoc": "^0.2.17",
     "prettier": "^2.8.8",
     "typescript": "^5.1.3"
   },
   "peerDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.59.1",
     "@typescript-eslint/parser": "^5.59.1",
     "eslint": "^8.39.0",
+    "eslint-plugin-tsdoc": "^0.2.17",
     "prettier": "^2.8.8",
     "typescript": "^5.0.4"
   }