/// <reference types="express" />
/// <reference types="cors" />
import { CorsOptions } from "cors";
import { Application } from "express";
import { SchemaBuilderOptions } from "./SchemaBuilderOptions";
import { RequestHandler } from "express-serve-static-core";
/**
 * Vesper framework initialization options.
 */
export interface VesperFrameworkOptions extends SchemaBuilderOptions {
    /**
     * Port on which http server must be launched.
     */
    port: number;
    /**
     * List of express middlewares to use.
     */
    use?: RequestHandler[];
    /**
     * If provided, then given express application instance will be used instead of creating a new one.
     * This way you can pre-configure your express application.
     */
    expressApp?: Application;
    /**
     * Route used for GraphQL controllers.
     * By default is equal to "/graphql".
     */
    graphQLRoute?: string;
    /**
     * Route used for GraphiQL.
     * By default is equal to "/graphiql".
     *
     * By default is disabled because playground is used.
     * You can explicitly enable it by setting this value to true.
     */
    graphIQLRoute?: string | boolean;
    /**
     * Route used for GraphQL playground.
     * This is an alternative to GraphiQL.
     * By default route equal to "/playground".
     * Its enabled only if NODE_ENV is not equal to "prod".
     * You can explicitly disable it by setting it to false.
     */
    playground?: string | boolean;
    /**
     * Indicates if cors are enabled.
     * Disabled by default.
     *
     * @see https://github.com/expressjs/cors
     */
    cors?: boolean | CorsOptions;
}