From 81dd03af27aad3de645eabe84872dd25e9d549e2 Mon Sep 17 00:00:00 2001 From: Tobias Schneider Date: Thu, 24 Nov 2022 23:33:48 +0100 Subject: [PATCH] ocd --- README.md | 12 +++---- src/index.ts | 100 +++++++++++++++++++++++++-------------------------- 2 files changed, 56 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 86b6263..67ab64a 100644 --- a/README.md +++ b/README.md @@ -33,13 +33,13 @@ import { Router } from '@tsndr/cloudflare-worker-router' export interface Env { // Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/ - // MY_KV_NAMESPACE: KVNamespace; + // MY_KV_NAMESPACE: KVNamespace // // Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/ - // MY_DURABLE_OBJECT: DurableObjectNamespace; + // MY_DURABLE_OBJECT: DurableObjectNamespace // // Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/ - // MY_BUCKET: R2Bucket; + // MY_BUCKET: R2Bucket } @@ -305,13 +305,13 @@ import { Router } from '@tsndr/cloudflare-worker-router' export interface Env { // Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/ - // MY_KV_NAMESPACE: KVNamespace; + // MY_KV_NAMESPACE: KVNamespace // // Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/ - // MY_DURABLE_OBJECT: DurableObjectNamespace; + // MY_DURABLE_OBJECT: DurableObjectNamespace // // Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/ - // MY_BUCKET: R2Bucket; + // MY_BUCKET: R2Bucket } const router = new Router() diff --git a/src/index.ts b/src/index.ts index 811e13f..844871a 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,6 +1,6 @@ /** * Route Object - * + * * @typedef Route * @property {string} method HTTP request method * @property {string} url URL String @@ -14,7 +14,7 @@ /** * Router Context - * + * * @typedef RouterContext * @property {RouterEnv} env Environment * @property {RouterRequest} req Request Object @@ -30,7 +30,7 @@ export interface RouterContext { /** * Request Object - * + * * @typedef RouterRequest * @property {string} url URL * @property {string} method HTTP request method @@ -53,7 +53,7 @@ export interface RouterRequest { /** * Request Parameters - * + * * @typedef RouterRequestParams */ export interface RouterRequestParams { @@ -62,7 +62,7 @@ export interface RouterRequestParams { /** * Request Query - * + * * @typedef RouterRequestQuery */ export interface RouterRequestQuery { @@ -71,7 +71,7 @@ export interface RouterRequestQuery { /** * Response Object - * + * * @typedef RouterResponse * @property {Headers} headers Response headers object * @property {number} [status=204] Return status code (default: `204`) @@ -88,7 +88,7 @@ export interface RouterResponse { /** * Next Function - * + * * @callback RouterNext * @returns {Promise} */ @@ -98,7 +98,7 @@ export interface RouterNext { /** * Handler Function - * + * * @callback RouterHandler * @param {RouterContext} ctx * @returns {Promise | void} @@ -109,7 +109,7 @@ export interface RouterHandler { /** * CORS Config - * + * * @typedef RouterCorsConfig * @property {string} [allowOrigin="*"] Access-Control-Allow-Origin (default: `*`) * @property {string} [allowMethods="*"] Access-Control-Allow-Methods (default: `*`) @@ -127,7 +127,7 @@ export interface RouterCorsConfig { /** * Router - * + * * @public * @class */ @@ -135,7 +135,7 @@ export class Router { /** * Router Array - * + * * @protected * @type {Route[]} */ @@ -143,7 +143,7 @@ export class Router { /** * Global Handlers - * + * * @protected * @type {RouterHandler[]} */ @@ -151,7 +151,7 @@ export class Router { /** * Debug Mode - * + * * @protected * @type {boolean} */ @@ -159,7 +159,7 @@ export class Router { /** * CORS Config - * + * * @protected * @type {RouterCorsConfig} */ @@ -175,7 +175,7 @@ export class Router { /** * Register global handlers - * + * * @param {RouterHandler[]} handlers * @returns {Router} */ @@ -188,9 +188,9 @@ export class Router { /** * Register CONNECT route - * - * @param {string} url - * @param {RouterHandler[]} handlers + * + * @param {string} url + * @param {RouterHandler[]} handlers * @returns {Router} */ public connect(url: string, ...handlers: RouterHandler[]): Router { @@ -199,9 +199,9 @@ export class Router { /** * Register DELETE route - * - * @param {string} url - * @param {RouterHandler[]} handlers + * + * @param {string} url + * @param {RouterHandler[]} handlers * @returns {Router} */ public delete(url: string, ...handlers: RouterHandler[]): Router { @@ -210,9 +210,9 @@ export class Router { /** * Register GET route - * - * @param {string} url - * @param {RouterHandler[]} handlers + * + * @param {string} url + * @param {RouterHandler[]} handlers * @returns {Router} */ public get(url: string, ...handlers: RouterHandler[]): Router { @@ -221,9 +221,9 @@ export class Router { /** * Register HEAD route - * - * @param {string} url - * @param {RouterHandler[]} handlers + * + * @param {string} url + * @param {RouterHandler[]} handlers * @returns {Router} */ public head(url: string, ...handlers: RouterHandler[]): Router { @@ -232,9 +232,9 @@ export class Router { /** * Register OPTIONS route - * - * @param {string} url - * @param {RouterHandler[]} handlers + * + * @param {string} url + * @param {RouterHandler[]} handlers * @returns {Router} */ public options(url: string, ...handlers: RouterHandler[]): Router { @@ -243,9 +243,9 @@ export class Router { /** * Register PATCH route - * - * @param {string} url - * @param {RouterHandler[]} handlers + * + * @param {string} url + * @param {RouterHandler[]} handlers * @returns {Router} */ public patch(url: string, ...handlers: RouterHandler[]): Router { @@ -254,9 +254,9 @@ export class Router { /** * Register POST route - * - * @param {string} url - * @param {RouterHandler[]} handlers + * + * @param {string} url + * @param {RouterHandler[]} handlers * @returns {Router} */ public post(url: string, ...handlers: RouterHandler[]): Router { @@ -265,9 +265,9 @@ export class Router { /** * Register PUT route - * - * @param {string} url - * @param {RouterHandler[]} handlers + * + * @param {string} url + * @param {RouterHandler[]} handlers * @returns {Router} */ public put(url: string, ...handlers: RouterHandler[]): Router { @@ -276,9 +276,9 @@ export class Router { /** * Register TRACE route - * - * @param {string} url - * @param {RouterHandler[]} handlers + * + * @param {string} url + * @param {RouterHandler[]} handlers * @returns {Router} */ public trace(url: string, ...handlers: RouterHandler[]): Router { @@ -287,9 +287,9 @@ export class Router { /** * Register route, ignoring method - * - * @param {string} url - * @param {RouterHandler[]} handlers + * + * @param {string} url + * @param {RouterHandler[]} handlers * @returns {Router} */ public any(url: string, ...handlers: RouterHandler[]): Router { @@ -298,7 +298,7 @@ export class Router { /** * Debug Mode - * + * * @param {boolean} [state=true] Whether to turn on or off debug mode (default: true) * @returns {Router} */ @@ -309,7 +309,7 @@ export class Router { /** * Enable CORS support - * + * * @param {RouterCorsConfig} [config] * @returns {Router} */ @@ -327,7 +327,7 @@ export class Router { /** * Register route - * + * * @private * @param {string} method HTTP request method * @param {string} url URL String @@ -346,7 +346,7 @@ export class Router { /** * Get Route by request - * + * * @private * @param {RouterRequest} request * @returns {Route | undefined} @@ -387,7 +387,7 @@ export class Router { /** * Handle requests - * + * * @param {TEnv} env * @param {Request} request * @param {any} [extend]