From fac3217b6e04f3d5e94a737a102e46a64caad0c5 Mon Sep 17 00:00:00 2001 From: andrewblond Date: Fri, 11 Sep 2015 17:01:04 +0300 Subject: [PATCH] Added docs for `exports` option --- api.ru.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/api.ru.md b/api.ru.md index c63644f..08967c5 100644 --- a/api.ru.md +++ b/api.ru.md @@ -83,7 +83,7 @@ module.exports = function(config) { `i18n` — технология сборки, которая транслирует данные из `?.keysets..js`-файлов в JavaScript. -Технология `i18n` инициализирует ядро `i18n` данными из объединенных keyset-файлов и возвращает функцию `BEM.i18n`, которую можно использовать из [шаблонов](/README.md#в-шаблонах) или [клиентского JavaScript](README.md#В-javascript). +Технология `i18n` инициализирует ядро `i18n` данными из объединенных keyset-файлов и возвращает функцию `i18n`, которую можно использовать из [шаблонов](/README.md#в-шаблонах) или [клиентского JavaScript](README.md#В-javascript). >API функции `i18n` описан в разделе [API `i18n`](README.md#api-i18n). @@ -91,7 +91,8 @@ module.exports = function(config) { * [target](#target-1) * [lang](#lang-1) -* [keysetsFile](#keysetsаile) +* [keysetsFile](#keysetsfile) +* [exports](#exports) #### target @@ -99,7 +100,6 @@ module.exports = function(config) { Имя файла, куда будет записан результат сборки необходимых данных из `?.keysets..js`-файла — скомпилированный файл `?.lang..js`. - #### lang Тип: `String`. Обязательная опция. @@ -118,6 +118,16 @@ module.exports = function(config) { `?.keysets..js`-файл — это результат выполнения [keysets](#keysets) — набор данных (`keysets`) для указанного языка, который используется технологией [i18n](#i18n) для формирования `?.lang..js`-файлов. +#### exports + +Тип: `Object`. По умолчанию — `{ globals: true, commonJS: true, ym: true }`. + +Настраивает способ получения функции `i18n`. Возможные опции: + +* `globals: true` — функция `i18n` будет доступна из глобальной переменной `BEM.I18N`, если в среде исполнения нет модульных систем. Чтобы глобальная переменная была доступна при наличии модульных систем, нужно указать специальное значение `globals: 'force'`. +* `commonJS: true` — скомпилированный файл можно подключить как CommonJS модуль. +* `ym: true` — функция `i18n` будет доступна из модульной системы [YModules](https://ru.bem.info/tools/bem/modules/). + ------------------------------------- **Пример**