@nahkies/typescript-express-runtime/dist/server.d.ts

Runtime package for code generated by @nahkies/openapi-code-generator using the typescript-express template

import type { Server } from "node:http";
import type { AddressInfo, ListenOptions } from "node:net";
import type { OptionsJson, OptionsText, OptionsUrlencoded } from "body-parser";
import { type CorsOptions, type CorsOptionsDelegate } from "cors";
import { type ErrorRequestHandler, type Express, type RequestHandler, type Router } from "express";
type Enumerate<N extends number, Acc extends number[] = []> = Acc["length"] extends N ? Acc[number] : Enumerate<N, [...Acc, Acc["length"]]>;
type IntRange<F extends number, T extends number> = F extends T ? F : Exclude<Enumerate<T>, Enumerate<F>> extends never ? never : Exclude<Enumerate<T>, Enumerate<F>> | T;
export type StatusCode1xx = IntRange<100, 199>;
export type StatusCode2xx = IntRange<200, 299>;
export type StatusCode3xx = IntRange<300, 399>;
export type StatusCode4xx = IntRange<400, 499>;
export type StatusCode5xx = IntRange<500, 599>;
export type StatusCode = StatusCode1xx | StatusCode2xx | StatusCode3xx | StatusCode4xx | StatusCode5xx;
export type Response<Status extends StatusCode, Type> = {
    status: Status;
    body: Type;
};
export declare const SkipResponse: unique symbol;
export declare class ExpressRuntimeResponse<Type> {
    private readonly status;
    private _body?;
    constructor(status: StatusCode);
    body(body: Type): this;
    unpack(): Response<StatusCode, Type | undefined>;
}
export type ExpressRuntimeResponder<Status extends StatusCode = StatusCode, Type = any> = {
    withStatus: (status: Status) => ExpressRuntimeResponse<Type>;
};
export type ServerConfig = {
    /**
     * set to "disabled" to disable cors middleware, omit or pass undefined for defaults
     *
     * by default, all origins are allowed. you probably don't want this in production,
     * so it's strongly recommended to explicitly configure this.
     **/
    cors?: "disabled" | CorsOptions | CorsOptionsDelegate | undefined;
    /**
     * set to "disabled" to disable body parsing middleware, omit or pass undefined for defaults.
     *
     * if disabling, ensure you pass a body parsing middleware that places the parsed
     * body on `req.body` for request body processing to work.
     **/
    body?: "disabled" | Partial<{
        json: OptionsJson;
        text: OptionsText;
        urlencoded: OptionsUrlencoded;
    }> | undefined;
    /**
     * provide arbitrary express middleware to be mounted before all request handlers
     * useful for mounting logging, alternative body parsers, etc
     */
    middleware?: RequestHandler[];
    /**
     * Provide a custom 404 handler
     */
    notFoundHandler?: RequestHandler;
    /**
     * Provide a custom error handler
     */
    errorHandler?: ErrorRequestHandler;
    /**
     * the router to use, normally obtained by calling the generated `createRouter`
     * function
     */
    router: Router;
    /**
     * the port to listen on, a randomly allocated port will be used if none passed
     * alternatively ListenOptions can be passed to control the network interface
     * bound to.
     */
    port?: number | ListenOptions;
};
export type Params<Params, Query, Body, Header> = {
    params: Params;
    query: Query;
    body: Body;
    headers: Header;
};
/**
 * Starts an Express server and listens on `port` or a randomly allocated port if none provided.
 * Enables CORS and body parsing by default. It's recommended to customize the CORS options
 * for production usage.
 *
 * If you need more control over your Express server you should avoid calling this function,
 * and instead mount the router from your generated codes `createRouter` call directly
 * onto a server you have constructed.
 */
export declare function startServer({ middleware, cors, body, port, router, notFoundHandler, errorHandler, }: ServerConfig): Promise<{
    app: Express;
    server: Server;
    address: AddressInfo;
}>;
export {};