LunaticServer

LunaticServer — это главный класс фреймворка Lunatic.

Расширяет

• Router

Конструктор

Сигнатура:

constructor(httpServer?: http.Server)

где

• httpServer: http.Server — скрытый сервер Node.js, лежащий в основе LunaticServer

Создает новый экземпляр LunaticServer. Вы можете указать базовый http.Server, например, для включения https или для интеграции с другими фреймворками, такими как Socket.io:

import { LunaticServer } from '@shelepuginivan/lunatic'
import { createServer } from 'http'
import { Server } from 'socket.io'

const app = new LunaticServer()
const httpServer = createServer(app.callback)
const io = new Server(httpServer)

Свойства

httpServer

Тип: readonly http.Server

Скрытый сервер Node.js, лежащий в основе LunaticServer

Методы

callback

Сигнатура:

callback(req: httpIncomingMessage, res: http.ServerResponse): void

где

• req: http.IncomingMessage — входящий HTTP-запрос
• res: http.ServerResponse — ответ сервера

Функция обратного вызова, которая обрабатывает запросы. Этот метод может быть передан в различные методы и конструкторы, например, в конструктор http.Server:

import { LunaticServer } from '@shelepuginivan/lunatic'
import { Server } from 'http'

const app = new LunaticServer()
const httpServer = new Server(app.callback)

disable

Сигнатура:

disable(feature: ApplicationFeature): LunaticServer

где

• feature: ApplicationFeature — особенность, которая будет отключена.

Отключает указанную особенность приложения.

enable

Сигнатура:

enable(feature: ApplicationFeature): LunaticServer

где

• feature: ApplicationFeature — особенность, которая будет включена.

Включает указанную особенность приложения.

toggle

Сигнатура:

toggle(feature: ApplicationFeature): LunaticServer

где

• feature: ApplicationFeature — — особенность, которая будет переключена.

Переключает указанную особенность приложения.

listen

Сигнатура:

listen(port?: number, hostname?: string, backlog?: number): Promise<void>

где

• port: number | undefined — порт, который будет прослушивать сервер
• hostname: string | undefined — IP-адрес, по которому будет прослушиваться сервер
• backlog: number | undefined — максимальная длина очереди ожидающих соединений

Запускает скрытый httpServer с заданными параметрами.

await app.listen(8000)

эквивалентно

import { LunaticServer } from '@shelepuginivan/lunatic'
import { createServer } from 'http'

const app = new LunaticServer()

const httpServer = createServer()
httpServer.on('request', app.callback)
httpServer.listen(8000)

renderer

Сигнатура:

renderer(renderFunction: RenderFunction): LunaticServer

где

• renderFunction: RenderFunction — функция, которая отрисовывает HTML шаблон

Определяет RenderFunction, которая будет использоваться в Response.render() и Response.renderFile() для отрисовки HTML-шаблонов.