@chubbyts/chubbyts-framework/dist/router/route.d.ts

A minimal, highly performant middleware PSR-15 inspired function based microframework built with as little complexity as possible, aimed primarily at those developers who want to understand all the vendors they use.

import type { Method } from '@chubbyts/chubbyts-http-types/dist/message';
import type { Handler } from '@chubbyts/chubbyts-http-types/dist/handler';
import type { Middleware } from '@chubbyts/chubbyts-http-types/dist/middleware';
import type { RequiredProperties } from '../types.js';
/**
 * ```ts
 * import type { PathOptions } from '@chubbyts/chubbyts-framework/dist/router/route';
 *
 * const pathOptions: PathOptions = { key: 'value' };
 * ```
 */
export type PathOptions = {
    [key: string]: unknown;
};
export type RouteWithGivenMethodArgument = {
    path: string;
    name: string;
    handler: Handler;
    middlewares?: Array<Middleware>;
    pathOptions?: PathOptions;
};
export type RouteArgument = {
    method: Method;
} & RouteWithGivenMethodArgument;
/**
 * ```ts
 * import type { Route } from '@chubbyts/chubbyts-framework/dist/router/route';
 *
 * const route: Route = {
 *   method: 'POST'
 *   path: '/api/users',
 *   handler: userCreateHandler,
 *   middlewares: [],
 *   pathOptions: {},
 *   attributes: {},
 *   _route: 'Route',
 * }
 * ```
 */
export type Route = RequiredProperties<RouteArgument, 'middlewares' | 'pathOptions'> & {
    attributes: Record<string, string>;
    _route: string;
};
/**
 * ```ts
 * import type { Group } from '@chubbyts/chubbyts-framework/dist/router/group';
 * import type { Route } from '@chubbyts/chubbyts-framework/dist/router/route';
 *
 * const group: Group = { ...,  _group: 'Group' };
 * const route: Route = { ...,  _route: 'Route' };
 *
 * isRoute(group) // false
 * isRoute(route) // true
 * ```
 */
export declare const isRoute: (route: unknown) => route is Route;
/**
 * ```ts
 * import type { ResponseFactory } from '@chubbyts/chubbyts-http-types/dist/message-factory';
 * import type { Method, Response, ServerRequest } from '@chubbyts/chubbyts-http-types/dist/message';
 * import type { Route } from '@chubbyts/chubbyts-framework/dist/router/route';
 * import { createRoute } from '@chubbyts/chubbyts-framework/dist/router/route';
 *
 * const responseFactory: ResponseFactory = ...;
 *
 * const route: Route = createRoute({
 *   method: 'GET'
 *   path: '/hello/:name([a-z]+)',
 *   name: 'hello',
 *   handler: async (request: ServerRequest): Promise<Response> => {
 *     const response = responseFactory(200);
 *     response.body.end(`Hello, ${request.attributes.name}`);
 *
 *     return {
 *       ...response,
 *       headers: { ...response.headers, 'content-type': ['text/plain'] }
 *     };
 *   },
 * });
 * ```
 */
export declare const createRoute: ({ method, path, name, handler, middlewares, pathOptions }: RouteArgument) => Route;
/**
 * ```ts
 * import type { Route } from '@chubbyts/chubbyts-framework/dist/router/route';
 * import { createDeleteRoute } from '@chubbyts/chubbyts-framework/dist/router/route';
 *
 * const route: Route = createDeleteRoute({
 *   path: '/api/users/:id',
 *   handler: userDeleteHandler,
 * });
 * ```
 */
export declare const createDeleteRoute: (args: RouteWithGivenMethodArgument) => Route;
/**
 * ```ts
 * import type { Route } from '@chubbyts/chubbyts-framework/dist/router/route';
 * import { createGetRoute } from '@chubbyts/chubbyts-framework/dist/router/route';
 *
 * const route: Route = createGetRoute({
 *   path: '/api/users/:id',
 *   handler: userReadHandler,
 * });
 * ```
 */
export declare const createGetRoute: (args: RouteWithGivenMethodArgument) => Route;
/**
 * ```ts
 * import type { Route } from '@chubbyts/chubbyts-framework/dist/router/route';
 * import { createHeadRoute } from '@chubbyts/chubbyts-framework/dist/router/route';
 *
 * const route: Route = createHeadRoute({
 *   path: '/api/users/:id',
 *   handler: userExistsHandler,
 * });
 * ```
 */
export declare const createHeadRoute: (args: RouteWithGivenMethodArgument) => Route;
/**
 * ```ts
 * import type { Route } from '@chubbyts/chubbyts-framework/dist/router/route';
 * import { createOptionsRoute } from '@chubbyts/chubbyts-framework/dist/router/route';
 *
 * const route: Route = createOptionsRoute({
 *   path: '/api/users/:id',
 *   handler: corsHandler,
 * });
 * ```
 */
export declare const createOptionsRoute: (args: RouteWithGivenMethodArgument) => Route;
/**
 * ```ts
 * import type { Route } from '@chubbyts/chubbyts-framework/dist/router/route';
 * import { createPatchRoute } from '@chubbyts/chubbyts-framework/dist/router/route';
 *
 * const route: Route = createPatchRoute({
 *   path: '/api/users/:id',
 *   handler: userUpdateHandler,
 * });
 * ```
 */
export declare const createPatchRoute: (args: RouteWithGivenMethodArgument) => Route;
/**
 * ```ts
 * import type { Route } from '@chubbyts/chubbyts-framework/dist/router/route';
 * import { createPostRoute } from '@chubbyts/chubbyts-framework/dist/router/route';
 *
 * const route: Route = createPostRoute({
 *   path: '/api/users',
 *   handler: userCreateHandler,
 * });
 * ```
 */
export declare const createPostRoute: (args: RouteWithGivenMethodArgument) => Route;
/**
 * ```ts
 * import type { Route } from '@chubbyts/chubbyts-framework/dist/router/route';
 * import { createPutRoute } from '@chubbyts/chubbyts-framework/dist/router/route';
 *
 * const route: Route = createPutRoute({
 *   path: '/api/users/:id',
 *   handler: userReplaceHandler,
 * });
 * ```
 */
export declare const createPutRoute: (args: RouteWithGivenMethodArgument) => Route;