Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

CreateExpress404Handler

  • CreateExpress404Handler(redirectTo?: string): RequestHandler
  • since

    2.0.14

    version

    2021-03-19

    Parameters

    • redirectTo: string = "/"

      default: /

    Returns RequestHandler

    RequestHandler

CreateExpressCheckReferer

  • CreateExpressCheckReferer(domainNames: string[], allowEmpty?: boolean, redirectTo?: string, status?: HttpStatusCode): RequestHandler
  • since

    2.0.14

    version

    2021-03-19

    Parameters

    • domainNames: string[]
    • allowEmpty: boolean = false

      default: false

    • Optional redirectTo: string
    • Optional status: HttpStatusCode

      default: 403

    Returns RequestHandler

CreateExpressErrorHandler

  • CreateExpressErrorHandler(log?: boolean, redirectTo?: string | undefined): ErrorRequestHandler
  • since

    2.0.14

    version

    2021-03-19

    Parameters

    • log: boolean = true

      default: true

    • redirectTo: string | undefined = "/"

      default: /

    Returns ErrorRequestHandler

    ErrorRequestHandler

CreateExpressLogger

  • CreateExpressLogger(): RequestHandler
  • since

    1.0.5

    version

    2021-03-19

    Returns RequestHandler

LoadEnv

  • LoadEnv(rootDir: string, ...files: string[]): undefined | DotenvParseOutput
  • Loads environment variables from a .env file into process.env

    since

    2.0.14

    version

    2021-03-19

    Parameters

    • rootDir: string
    • Rest ...files: string[]

    Returns undefined | DotenvParseOutput

StartServer

  • StartServer(app: http.RequestListener, port: number, options?: IStartServerOptions): Promise<void>
  • since

    2.0.14

    version

    2021-03-19

    Parameters

    Returns Promise<void>

Legend

  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Interface
  • Interface with type parameter
  • Enumeration
  • Class

Generated using TypeDoc