Response

HTTP-ответ сервера. Часто обозначается как параметр res.

Конструктор

Этот раздел пуст.

Свойства

serverResponse

Тип: http.ServerResponse

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

Properties

Этот раздел пуст.

Methods

earlyHints

Сигнатура:

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

где

• hints: Record<string, string | string[]> — Заголовки Early Hints, которые должны быть отправлены

Отправляет информационный ответ 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')
})

end

Сигнатура:

end(): Promise<void>

Sends all response headers and body

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

json

Сигнатура:

json(body: object): Promise<void>

где

• body: object — тело ответа

Отправляет заголовки и тело ответа с типом application/json.

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

text

Сигнатура:

text(body: string): Promise<void>

где

• body: string — тело ответа

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

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

redirect

Сигнатура:

redirect(location: string): Promise<void>

где

• location: string — путь перенаправления

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

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

render

Сигнатура:

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

где

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

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

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

renderFile

Сигнатура:

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

где

• path: string — путь до файла шаблона
• options: Record<string, unknown> | undefined — параметры шаблона

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

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

send

Сигнатура:

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

где

• content: string | Buffer | undefined — тело запроса
• mimetype: string | undefined — MIME-тип тела запроса

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

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

sendFile

Сигнатура:

sendFile(path: string): Promise<void>

где

• path: string — путь до файла

Отправляет указанный файл в качестве тела ответа. MIME-тип определяется по расширению и по умолчанию равен application/octet-stream.

setCookie

Сигнатура:

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

где

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

Устанавливает куки для данного запроса. Второй аргумент задает атрибуты заголовка Set-Cookie.

clearCookie

Сигнатура:

clearCookie(name: string, options?: CookieOptions): Response

где

• name: string — название куки
• options: CookieOptions | undefined — атрибуты HTTP-залоговка Set-Cookie

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

setHeader

Сигнатура:

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

где

• name: string — название залоговка
• value: number | string | string[] — значение заголовка

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

setHeaders

Сигнатура:

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

где

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

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