Types

Importable types and interfaces of the Lunatic framework.

Interfaces

CorsOptions

Type:

interface CorsOptions {
    allowedHeaders?: string | string[]
    corsErrorStatus?: number
    credentials?: boolean
    exposedHeaders?: string | string[]
    maxAge?: number
    methods?: HttpMethod | HttpMethod[]
    origin?:
        | boolean
        | string
        | string[]
        | RegExp
        | RegExp[]
        | ((origin: string) => boolean)
    preflightSuccessStatus?: number
}

Configuration options of the CORS middleware.

ServeStaticOptions

Type:

interface ServeStaticOptions {
    dotfiles?: 'allow' | 'forbid' | 'ignore'
    etag?: boolean
    index?: string | false
    lastModified?: boolean
}

Configuration options of the Static file server middleware.

UploadedFile

Type:

interface UploadedFile {
    data: Buffer
    filename: string
    mimetype: string
}

File that is uploaded via a multipart/form-data form.

Types

ApplicationFeature

Type:

type ApplicationFeature = '500-on-error' | 'auto-head-handler' | 'x-powered-by'

Available Application features.

CookieOptions

Type:

type CookieOptions = {
    domain?: string
    expires?: string | number
    httpOnly?: boolean
    maxAge?: number
    path?: string
} & (
    | {
          sameSite?: 'None'
          secure: true
      }
    | {
          sameSite?: 'Lax' | 'Strict'
          secure?: boolean
      }
)

Object representation of the Set-Cookie header attributes.

HttpMethod

Type:

type HttpMethod =
    | 'GET'
    | 'HEAD'
    | 'POST'
    | 'PUT'
    | 'DELETE'
    | 'CONNECT'
    | 'OPTIONS'
    | 'TRACE'
    | 'PATCH'
    | '*'

HTTP request method.

NextHandler

type NextHandler = () => void

Next middleware, 3rd parameter of RequestHandler.

RenderFunction

Type:

type RenderFunction = (source: string, options?: Record<string, any>) => string

Render function, used to render HTML templates.

RequestHandler

Type:

type RequestHandler = (
    req: Request,
    res: Response,
    next: NextHandler,
) => unknown

Request handler function.

Enums

Status

Type:

enum Status {
    Continue = 100,
    SwitchingProtocols = 101,
    Processing = 102,
    EarlyHints = 103,

    Ok = 200,
    Created = 201,
    Accepted = 202,
    NonAuthoritativeInformation = 203,
    NoContent = 204,
    ResetContent = 205,
    PartialContent = 206,
    MultiStatus = 207,
    AlreadyReported = 208,
    IMUsed = 226,

    MultipleChoices = 300,
    MovedPermanently = 301,
    Found = 302,
    SeeOther = 303,
    NotModified = 304,
    TemporaryRedirect = 307,
    PermanentRedirect = 308,

    BadRequest = 400,
    Unauthorized = 401,
    PaymentRequired = 402,
    Forbidden = 403,
    NotFound = 404,
    MethodNotAllowed = 405,
    NotAcceptable = 406,
    ProxyAuthenticationRequired = 407,
    RequestTimeout = 408,
    Conflict = 409,
    Gone = 410,
    LengthRequired = 411,
    PreconditionFailed = 412,
    PayloadTooLarge = 413,
    URITooLong = 414,
    UnsupportedMediaType = 415,
    RangeNotSatisfiable = 416,
    ExpectationFailed = 417,
    ImATeapot = 418,
    MisdirectedRequest = 421,
    UnprocessableContent = 422,
    Locked = 423,
    FailedDependency = 424,
    TooEarly = 425,
    UpgradeRequired = 426,
    PreconditionRequired = 428,
    TooManyRequests = 429,
    RequestHeaderFieldsTooLarge = 431,
    UnavailableForLegalReasons = 451,

    InternalServerError = 500,
    NotImplemented = 501,
    BadGateway = 502,
    ServiceUnavailable = 503,
    GatewayTimeout = 504,
    HTTPVersionNotSupported = 505,
    VariantAlsoNegotiates = 506,
    InsufficientStorage = 507,
    LoopDetected = 508,
    NotExtended = 510,
    NetworkAuthenticationRequired = 511,
}

HTTP status enum. Can be used in place of “magic numbers” indicating response status:

res.status(200).end()
res.status(Status.Ok).end()

To learn more about response status codes, see HTTP status codes on MDN.