Типы

Типы и интерфейсы фреймворка Lunatic.

Интерфейсы

CorsOptions

Настройки middleware-функции CORS.

export 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
}

ServeStaticOptions

Настройки middleware-функции serveStatic.

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

UploadedFile

Файл, отправленный на сервер через форму.

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

См. formParser

Типы

ApplicationFeature

Функция приложение, которая может быть включена, отключена и переключена.

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

См. Функции приложения

CookieOptions

Объект с настройками атрибутов заголовка Set-Cookie.

См. Response.setCookie.

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

HttpMethod

HTTP-метод запроса.

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

См. Роутинг

NextHandler

Следующая middleware-функция, передаётся как третий параметр (next) в функции-обработчики (см. RequestHandler). Можно вызвать при помощи next().

export type NextHandler = () => void

См. Роутинг

RenderFunction

Функция-рендерер HTML шаблонов.

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

См. Шаблонизаторы

RequestHandler

Функция-обработчик запросов

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

См. Request, NextHandler