Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Functions

Type aliases

CanonicalResolver

CanonicalResolver<T>: (key: string) => T | undefined

Type alias for a function that resolves a canonical name to a canonical item, if one exists.

Type parameters

  • T

Type declaration

    • (key: string): T | undefined
    • Parameters

      • key: string

      Returns T | undefined

HTTPMethod

HTTPMethod: "post" | "get" | "patch" | "put" | "delete" | "unknown"

Enumeration of different HTTP verbs.

todo

add others?

MaybeHTTPCookie

MaybeHTTPCookie: HTTPCookie | undefined

Type alias for something that is either an HTTP cookie, or undefined.

ResolvedRouteHandler

ResolvedRouteHandler: (request: Request) => ResponseObject

Type alias for a function that applies a route handler to the request. The goal is to transform RouteHandlers to ResolvedRouteHandler.

Type declaration

ResponseObject

ResponseObject: ResponseFactory | string | number | void | any | Promise<ResponseObject>

Type alias for an item that is a valid response object, or lack thereof.

RouteHandler

RouteHandler: ((request: Request, response: Response) => ResponseObject) | ((request: Request) => ResponseObject) | (() => ResponseObject) | string

Type alias for an item that defines a direct route handler.

SessionData

SessionData: {}

Type alias describing some inflated session data.

Type declaration

  • [key: string]: any

Functions

appPath

  • appPath(...parts: PathLike[]): UniversalPath

basePath

  • basePath(...parts: PathLike[]): UniversalPath

dehydrate

env

  • env(key: string, defaultValue?: any): any
  • Helper function that resolves and infers environment variable values.

    If none is found, returns defaultValue.

    Parameters

    • key: string
    • Optional defaultValue: any

    Returns any

error

  • error(error: Error | string, status?: HTTPStatus, output?: "json" | "html" | "auto"): ErrorResponseFactory

html

http

isBindable

  • isBindable(what: any): what is Bindable

isHTTPMethod

json

plaintext

redirect

view

Extollo Logo

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.