Response

Ответ, отправляемый сервером, который передаётся как второй аргумент middleware-функции

Методы

`res.clearCookie(name: string, options?: CookieOptions): Response`

name: string - имя куки
options: CookieOptions - атрибуты заголовка Cookie

Очищает куки. Некоторые атрибуты куки, которые можно указать в аргументе options, такие как Path или Domain, должны быть теми же, что и при создании куки.

`res.earlyHints(hints: Record<string, string | string[]>): Promise<void>`

hints: Record<string, string | string[]> - заголовки информационного ответа

Отправляет информационный статус 103 Early Hints:

app.get('/', async (_req, res) => {
    await res.earlyHints({
        link: '<style.css/>; rel=preload; as=style',
    })

    await res.status(200).renderFile('templates/index.html')
})

`res.end(): Promise<void>`

Отправляет ответ на запрос.

После вызова этого метода, запрос считается завершённым, другие данные не могут быть отправлены. Попытка вызвать другой метод, который отправляет ответ, после того, как ответ уже был отправлен, приведёт к исключению.

`res.json(body: object): Promise<void>`

body: object - тело ответа

Отправляет ответ на запрос с телом в формате JSON (тип application/json).

`res.redirect(location: string): Promise<void>`

location: string - путь, на который запрос будет перенаправлен

Перенаправляет запрос, устанавливая заголовок Location.

`res.removeHeader(name: string): Response`

name: string - название заголовка

Убирает заголовок ответа.

`res.removeHeaders(headers: string[]): Response`

headers: string[] - названия заголовков

Удаляет несколько заголовков ответа, вызывая res.removeHeader() для каждого из них.

`res.render(source: string, options?: Record<string, unknown>): Promise<void>`

source: string - исходное содержание шаблона
options: Record<string, unknown> - параметры шаблона

Рендерит HTML-шаблон с помощью функции-рендерера (См. RenderFunction), которая указана в методе LunaticServer.renderer() и отправляет его.

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

`res.renderFile(path: string, options?: Record<string, unknown>): Promise<void>`

path: string - путь к файлу шаблона
options: Record<string, unknown> - параметры шаблона

Рендерит файл HTML-шаблона с помощью функции-рендерера (См. RenderFunction), которая указана в методе LunaticServer.renderer() и отправляет его.

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

`res.send(content?: string | Buffer, mimetype?: string): Promise<void>`

content: string | Buffer - тело ответа
mimetype: string - MIME-тип тела ответа

Отправляет тело запроса, переданное как аргумент content. MIME-тип указывается аргументом mimetype (по умолчанию application/octet-stream). Если аргумент content не указан или равен undefined, отвечает статусом 204 No Content.

`res.sendFile(path: string): Promise<void>`

path: string - путь к файлу

Отправляет ответ в виде файла. Значение заголовка Content-Type определяется по расширению файла, если расширение неизвестно, то значение Content-Type будет установлено как application/octet-stream.

`res.setCookie(name: string, value: number | string, options?: CookieOptions): Response`

name: string - название куки
value: number | string - значение куки
options: CookieOptions - атрибуты заголовка Cookie

Устанавливает куки, указывая заголовок ответа Set-Cookie. Второй аргумент, options (см. CookieOptions) устанавливает атрибуты заголовка Set-Cookie .

`res.setHeader(name: string, value: number | string | string[]): Response`

name: string - имя заголовка
value: number | string | string[] - значение заголовка

Устанавливает заголовок ответа. Если указанное значение - массив строк, то заголовк будет установлен для каждого элемента массива.

`res.setHeaders(headers: Record<string, number | string | string[]>): Response`

headers: Record<string, number | string | string[]> - заголовки, которые будут установлены

Устанавливает несколько заголовков ответа, вызывая res.setHeader() для каждого указаного заголовка.

`res.status(status: number): Response`

status: number - статус ответа сервера

Устанавливает статус ответа.

`res.text(body: string): Promise<void>`

body: string - тело ответа

Отправляет текстовое (тип text/plain) тело запроса.

`res.withoutBody(): Response`

Этот метод сигнализирует серверу, что ответ должен быть отправлен без тела. Сервер автоматически устанавливает статус 204 No Content. Может быть использовано для обработки HEAD запросов, так как позволяет ответить теми же заголовками, но без тела.

Свойства

`res.serverResponse`

Тип: http.ServerResponse

Внутренний объект http.ServerResponse. Может быть использован для доступа к низкоуровневому API Node.js модуля http.

Response

Методы​

res.clearCookie(name: string, options?: CookieOptions): Response​

res.earlyHints(hints: Record<string, string | string[]>): Promise<void>​

res.end(): Promise<void>​

res.json(body: object): Promise<void>​

res.redirect(location: string): Promise<void>​

res.removeHeader(name: string): Response​

res.removeHeaders(headers: string[]): Response​

res.render(source: string, options?: Record<string, unknown>): Promise<void>​

res.renderFile(path: string, options?: Record<string, unknown>): Promise<void>​

res.send(content?: string | Buffer, mimetype?: string): Promise<void>​

res.sendFile(path: string): Promise<void>​

res.setCookie(name: string, value: number | string, options?: CookieOptions): Response​

res.setHeader(name: string, value: number | string | string[]): Response​

res.setHeaders(headers: Record<string, number | string | string[]>): Response​

res.status(status: number): Response​

res.text(body: string): Promise<void>​

res.withoutBody(): Response​

Свойства​

res.serverResponse​