js-trie-router-cors

@e22m4u/js-trie-router-cors

Модуль поддержки CORS для @e22m4u/js-trie-router

Содержание

• Установка
• Использование
• Тесты
• Лицензия

Установка

Модуль поддерживает ESM и CommonJS стандарты.

ESM

CommonJS

Использование

Подключение модуля к маршрутизатору выполняется через внедрение зависимости. Сервис регистрируется с передачей объекта настроек.

Настройки

Модуль позволяет определить объект настроек со следующими свойствами. Каждое свойство отвечает за отдельный аспект работы модуля.

origin

Тип:

По умолчанию:

false

Опция управляет проверкой источника. Возможные варианты значений представлены ниже.

• false
  - отключает отправку CORS заголовков (по умолчанию);
• true
  - разрешает все источники (отражает источник запроса);
• *
  - разрешает любые источники запросов (для публичного API);
• http://example.com
  - указывает точный адрес источника;
• /example\.com$/
  регулярное выражение для проверки адреса;
• [...]
  массив допустимых адресов или регулярных выражений;
• (origin) => true
  функция для проверки адреса;

Допускается указание конкретных источников через запятую.

Значения

и

true

разрешают доступ любым адресам. Разница заключается в формировании заголовков ответа сервера.

origin: '*'

При передаче символа звездочки сервер отправляет разрешающий заголовок со значением

. Разрешающий заголовок добавляется ко всем ответам, даже в рамках одного домена. Наличие информации об источнике во входящем запросе не проверяется. Данный режим рекомендуется для публичных API, не использующих авторизацию.

Access-Control-Allow-Origin: *

origin: true

Значение

включает режим отражения. Маршрутизатор читает адрес источника из заголовка

Origin

и возвращает его точное значение в ответе сервера. Дополнительно устанавливается заголовок

Vary

. Если входящий запрос не имеет информации об источнике (не кросс-доменный запрос), то установка CORS заголовков пропускается.

Access-Control-Allow-Origin: http://example.com
Vary: Origin

origin: '*'

и

credentials: true

Наличие флага передачи данных авторизации изменяет поведение символа звездочки. Спецификация запрещает совмещать данный флаг и разрешающий символ

. При таком сочетании маршрутизатор автоматически переключается в режим отражения адреса источника.

Access-Control-Allow-Origin: http://example.com
Access-Control-Allow-Credentials: true

methods

Тип:

По умолчанию:

GET, HEAD, PUT, PATCH, POST, DELETE

Опция задает разрешенные методы. Значение по умолчанию включает базовые методы протокола. Допускается передача строки или массива.

allowedHeaders

Тип:

По умолчанию:

undefined

Опция задает разрешенные заголовки. По умолчанию модуль применяет принцип зеркала. Разрешаются только запрошенные клиентом заголовки.

exposedHeaders

Тип:

По умолчанию:

undefined

Опция определяет заголовки для чтения на стороне клиента. Значением может быть строка или массив строк.

credentials

Тип:

По умолчанию:

false

Опция управляет передачей данных авторизации. Установка значения

добавляет разрешающий заголовок в ответ сервера.

maxAge

Тип:

По умолчанию:

undefined

Опция указывает время жизни предварительного запроса. Срок действия передается в секундах.

Тесты

Лицензия

MIT