From 606d5f1cb2a26cc2808f0be34a08ac349530bb06 Mon Sep 17 00:00:00 2001 From: Toby Date: Thu, 16 Nov 2023 22:38:51 +0100 Subject: [PATCH] clean up --- src/index.ts | 72 ++++++++++++++++++++++++++-------------------------- 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/src/index.ts b/src/index.ts index 1f06824..f44cb3e 100644 --- a/src/index.ts +++ b/src/index.ts @@ -6,10 +6,10 @@ * @property {string} url URL String * @property {RouterHandler[]} handlers Array of handler functions */ -export type Route = { +export type Route = { method: string url: string - handlers: RouterHandler[] + handlers: RouterHandler[] } /** @@ -20,9 +20,9 @@ export type Route = { * @property {RouterRequest} req Request Object * @property {ExecutionContext} ctx Context Object */ -export type RouterContext = TCtx & { - env: TEnv - req: RouterRequest +export type RouterContext = CtxExt & { + env: Env + req: RouterRequest dbg: boolean ctx?: ExecutionContext } @@ -39,7 +39,7 @@ export type RouterContext = TCtx & { * @property {Request} raw Raw Request Object * @property {IncomingRequestCfProperties} [cf] object containing custom Cloudflare properties. (https://developers.cloudflare.com/workers/examples/accessing-the-cloudflare-object) */ -export type RouterRequest = TReq & { +export type RouterRequest = ReqExt & { url: string method: string params: RouterRequestParams @@ -51,7 +51,7 @@ export type RouterRequest = TReq & { json(): Promise formData(): Promise blob(): Promise - bearer: () => string | undefined + bearer(): string | undefined cf?: IncomingRequestCfProperties } @@ -80,8 +80,8 @@ export type RouterRequestQuery = { * @param {RouterContext} ctx * @returns {Promise Response | void} */ -export type RouterHandler = { - (ctx: RouterContext): Promise | Response | void +export type RouterHandler = { + (ctx: RouterContext): Promise | Response | void } /** @@ -120,7 +120,7 @@ export type RouterBuffer = { * @public * @class */ -export class Router { +export class Router { /** * Router Array @@ -128,7 +128,7 @@ export class Router { * @protected * @type {Route[]} */ - protected routes: Route[] = [] + protected routes: Route[] = [] /** * Global Handlers @@ -136,7 +136,7 @@ export class Router { * @protected * @type {RouterHandler[]} */ - protected globalHandlers: RouterHandler[] = [] + protected globalHandlers: RouterHandler[] = [] /** * Debug Mode @@ -168,7 +168,7 @@ export class Router { * @param {RouterHandler[]} handlers * @returns {Router} */ - public use(...handlers: RouterHandler[]): Router { + public use(...handlers: RouterHandler[]): Router { for (let handler of handlers) { this.globalHandlers.push(handler) } @@ -182,7 +182,7 @@ export class Router { * @param {RouterHandler[]} handlers * @returns {Router} */ - public connect(url: string, ...handlers: RouterHandler[]): Router { + public connect(url: string, ...handlers: RouterHandler[]): Router { return this.register('CONNECT', url, handlers) } @@ -193,7 +193,7 @@ export class Router { * @param {RouterHandler[]} handlers * @returns {Router} */ - public delete(url: string, ...handlers: RouterHandler[]): Router { + public delete(url: string, ...handlers: RouterHandler[]): Router { return this.register('DELETE', url, handlers) } @@ -204,7 +204,7 @@ export class Router { * @param {RouterHandler[]} handlers * @returns {Router} */ - public get(url: string, ...handlers: RouterHandler[]): Router { + public get(url: string, ...handlers: RouterHandler[]): Router { return this.register('GET', url, handlers) } @@ -215,7 +215,7 @@ export class Router { * @param {RouterHandler[]} handlers * @returns {Router} */ - public head(url: string, ...handlers: RouterHandler[]): Router { + public head(url: string, ...handlers: RouterHandler[]): Router { return this.register('HEAD', url, handlers) } @@ -226,7 +226,7 @@ export class Router { * @param {RouterHandler[]} handlers * @returns {Router} */ - public options(url: string, ...handlers: RouterHandler[]): Router { + public options(url: string, ...handlers: RouterHandler[]): Router { return this.register('OPTIONS', url, handlers) } @@ -237,7 +237,7 @@ export class Router { * @param {RouterHandler[]} handlers * @returns {Router} */ - public patch(url: string, ...handlers: RouterHandler[]): Router { + public patch(url: string, ...handlers: RouterHandler[]): Router { return this.register('PATCH', url, handlers) } @@ -248,7 +248,7 @@ export class Router { * @param {RouterHandler[]} handlers * @returns {Router} */ - public post(url: string, ...handlers: RouterHandler[]): Router { + public post(url: string, ...handlers: RouterHandler[]): Router { return this.register('POST', url, handlers) } @@ -259,7 +259,7 @@ export class Router { * @param {RouterHandler[]} handlers * @returns {Router} */ - public put(url: string, ...handlers: RouterHandler[]): Router { + public put(url: string, ...handlers: RouterHandler[]): Router { return this.register('PUT', url, handlers) } @@ -270,7 +270,7 @@ export class Router { * @param {RouterHandler[]} handlers * @returns {Router} */ - public trace(url: string, ...handlers: RouterHandler[]): Router { + public trace(url: string, ...handlers: RouterHandler[]): Router { return this.register('TRACE', url, handlers) } @@ -281,7 +281,7 @@ export class Router { * @param {RouterHandler[]} handlers * @returns {Router} */ - public any(url: string, ...handlers: RouterHandler[]): Router { + public any(url: string, ...handlers: RouterHandler[]): Router { return this.register('*', url, handlers) } @@ -291,7 +291,7 @@ export class Router { * @param {boolean} [state=true] Whether to turn on or off debug mode (default: true) * @returns {Router} */ - public debug(state: boolean = true): Router { + public debug(state: boolean = true): Router { this.debugMode = state return this } @@ -302,7 +302,7 @@ export class Router { * @param {RouterCorsConfig} [config] * @returns {Router} */ - public cors(config?: RouterCorsConfig): Router { + public cors(config?: RouterCorsConfig): Router { this.corsEnabled = true this.corsConfig = { allowOrigin: config?.allowOrigin ?? '*', @@ -341,7 +341,7 @@ export class Router { * @param {RouterHandler[]} handlers Arrar of handler functions * @returns {Router} */ - private register(method: string, url: string, handlers: RouterHandler[]): Router { + private register(method: string, url: string, handlers: RouterHandler[]): Router { this.routes.push({ method, url, @@ -358,7 +358,7 @@ export class Router { * @param {RouterRequest} request * @returns {Route | undefined} */ - private getRoute(request: RouterRequest): Route | undefined { + private getRoute(request: RouterRequest): Route | undefined { const url = new URL(request.url) const pathArr = url.pathname.split('/').filter(i => i) @@ -396,15 +396,15 @@ export class Router { * Handle requests * * @param {Request} request - * @param {TEnv} env - * @param {TCtx} [extCtx] - * @param {TReq} [extReq] + * @param {Env} env + * @param {CtxExt} [ctxExt] + * @param {ReqExt} [reqExt] * @returns {Promise} */ - public async handle(request: Request, env: TEnv, ctx?: ExecutionContext, extCtx?: TCtx, extReq?: TReq): Promise { - const buffer: RouterBuffer = {}; + public async handle(request: Request, env: Env, ctx?: ExecutionContext, ctxExt?: CtxExt, reqExt?: ReqExt): Promise { + const buffer: RouterBuffer = {} const req = { - ...(extReq ?? {}), + ...(reqExt ?? {}), method: request.method, headers: request.headers, url: request.url, @@ -418,7 +418,7 @@ export class Router { formData: async (): Promise => buffer.formData ? buffer.formData : buffer.formData = await request.clone().formData(), blob: async (): Promise => buffer.blob ? buffer.blob : buffer.blob = await request.clone().blob(), bearer: () => request.headers.get('Authorization')?.replace(/^(B|b)earer /, '').trim() - } as RouterRequest + } as RouterRequest if (this.corsEnabled && req.method === 'OPTIONS') { return new Response(null, { @@ -439,12 +439,12 @@ export class Router { for (const handler of handlers) { const context = { - ...(extCtx ?? {}), + ...(ctxExt ?? {}), env, req, dbg, ctx - } as RouterContext + } as RouterContext const res = await handler(context)