Hierarchy
- HttpResponse
Methods
content
-
Установить содержимое тела ответа строкой.
Parameters
-
data: string
Строка с данными тела ответа.
Returns this
-
cookie
-
Установить значение cookie.
Parameters
-
name: string
Имя cookie.
-
value: string
Значение cookie.
-
Optional options: CookieOptions
Опции для передачи и хранения cookie.
Returns this
-
json
-
Установить тело ответа из объекта JSON.
Обратите внимание, что при передаче ответа используется функция
JSON.stringify, и при наличии циклических ссылок формирование ответа будет падать с ошибкой.Также данный метод устанавливает заголовок ответа
Content-Type: application/json. Если необходимо, вы можете установить для него другое значение.return new HttpResponse(HttpStatusCode.CREATED) .json({content: 'created'}) .set('Content-Type', 'text/javascript'); //Old IE now happyВы можете передать в качестве
dataэкземпляр объекта, в котором реализована функцияjson(), возвращающая объект состояния данного экземпляра.function MyClass() {}; MyClass.prototype.json = function() { return { id: 1, value: 'string' } }; const myData = new MyClass(); const resp = new HttpResponse().json(myData);Parameters
-
data: any
Данные в формате JSON объекта, массива или экземпляра функции.
Returns this
-
location
-
Установить заголовок
Location.Parameters
-
url: string
Значение ссылки, установленное в
Location.
Returns this
-
redirect
-
Сформировать перенаправление запроса. По умолчанию передается код 302.
Parameters
-
url: string
-
Optional status: HttpStatusCode | number
Returns this
-
set
-
Установить значение HTTP-заголовока.
Parameters
-
name: string
Имя заголовка.
-
value: string
Значение заголовка.
Returns this
-
setFile
-
Установить в тело ответа файл.
Тело файла в методе скачивать не требуется. Оно будет передано в тело HTTP-ответа самой платформой.
async function downloadFile(req: FetchRequest): Promise<HttpResponse | void> { const file = await System.files.search() .where(f => f.__id.eq("b57ef952-2861-45e1-9dd0-fa5e042ab4ef")).first(); const resp = new HttpResponse(); resp.setFile(file!); return resp; }Parameters
-
file: FileItem
Ссылка на элемент файла FileItem.
-
Optional name: undefined | string
Имя файла, которое будет использовано для скачивания пользователем.
Returns this
-
status
-
Установить код ответа.
Parameters
-
statusCode: HttpStatusCode | number
Код HTTP-ответа (см. также HttpStatusCode).
Returns this
-
Ответ сервера
Позволяет формировать HTTP-ответ на запросы с сервера.
Конструктор опционально принимает код в виде числа или значение HttpStatusCode.
const resp1 = new HttpResponse(404); const resp2 = new HttpResponse(HttpStatusCode.UNAUTHORIZED);Методы можно выстраивать в цепочки. Все методы меняют сам объект ответа и возвращают его же.
const resp = new HttpResponse(); resp .status(201) .content('awesome') .json({content: 'created'}) .cookie('sessionId', 'uniqueSessId') .location('https://example.com/path') .redirect('/same_url', 301) .set('Content-Type', 'text/html'); return resp;