@orion-js/http 3.11.8 → 3.12.0

package/dist/index.d.ts

@@ -0,0 +1,79 @@
+// Generated by dts-bundle-generator v9.5.1
+
+import express from 'express';
+import { Request as Request$1, Response as Response$1 } from 'express';
+
+export type onErrorFunction = (req: express.Request, res: express.Response, error: any) => Promise<void>;
+export declare const onError: onErrorFunction;
+export declare const setOnError: (onErrorFunc: onErrorFunction) => void;
+export declare const getViewer: (req: express.Request) => Promise<any>;
+export declare const setGetViewer: (getViewerFunc: (req: express.Request) => any) => void;
+export interface StartOrionOptions {
+	keepAliveTimeout?: number;
+}
+export declare const startServer: (port?: number, otherOptions?: StartOrionOptions) => express.Express;
+export declare const getApp: () => express.Express;
+export declare const getServer: () => any;
+export interface RouteResponseObject {
+	statusCode?: number;
+	headers?: {
+		[key: string]: string;
+	};
+	body: string | object;
+}
+export type RouteResponse = Promise<RouteResponseObject | void>;
+export type RouteResolve = (req: express.Request, res: express.Response, viewer: any) => RouteResponse;
+export interface OrionRouteOptions {
+	/**
+	 * The http method of the requests to match.
+	 */
+	method: "get" | "post" | "put" | "delete" | "all";
+	/**
+	 * The path of the requests to match.
+	 */
+	path: string;
+	/**
+	 * Select the body parser to use for this route.
+	 */
+	bodyParser?: "json" | "text" | "urlencoded";
+	/**
+	 * Selected body parser options.
+	 */
+	bodyParserOptions?: bodyParser.OptionsJson | bodyParser.OptionsText | bodyParser.OptionsUrlencoded;
+	/**
+	 * Add a middleware to the route.
+	 * See https://expressjs.com/en/4x/api.html#middleware
+	 * for more information.
+	 */
+	middlewares?: Array<express.RequestHandler>;
+	resolve: RouteResolve;
+	/**
+	 * Pass another express app
+	 */
+	app?: express.Application;
+}
+export interface RouteType extends OrionRouteOptions {
+}
+export interface RoutesMap {
+	[key: string]: RouteType;
+}
+export function route(options: OrionRouteOptions): RouteType;
+export function registerRoute(route: RouteType): void;
+export function registerRoutes(routesMap: RoutesMap): void;
+export declare function Routes(): ClassDecorator;
+export declare function Route(options: Omit<OrionRouteOptions, "resolve">): (target: any, propertyKey: string, descriptor: TypedPropertyDescriptor<RouteResolve>) => void;
+export declare function getServiceRoutes(target: any): RoutesMap;
+export declare const bodyParser: {
+	json: (options?: import("body-parser").OptionsJson) => import("connect").NextHandleFunction;
+	raw: (options?: import("body-parser").Options) => import("connect").NextHandleFunction;
+	text: (options?: import("body-parser").OptionsText) => import("connect").NextHandleFunction;
+	urlencoded: (options?: import("body-parser").OptionsUrlencoded) => import("connect").NextHandleFunction;
+};
+
+export {
+	Request$1 as Request,
+	Response$1 as Response,
+	express,
+};
+
+export {};