typograf/docs/api_entities.md

The client and server typography

# HTML-сущности

После обработки текста HTML-сущности преобразуются в один из трёх типов:

|№ |Тип                    |`type`      |Пример           |
|--|-----------------------|------------|-----------------|
|1.|Готовые символы (UTF-8)|По умолчанию|`«Я»`            |
|2.|В виде цифр            |`digit`     |`«Я»`  |
|3.|В виде имён            |`name`      |`«Я»`|

## Примеры
HTML-сущности готовыми символами, по умолчанию:
```js
const tp = new Typograf({locale: ['ru', 'en-US']});
tp.execute('12 кг...'); // 12 кг…
```

HTML-сущности в виде имён:
```js
const tp = new Typograf({
    locale: ['ru', 'en-US'],
    htmlEntity: {type: 'name'}
});
tp.execute('12 кг...'); // 12 кг…
```

HTML-сущности в виде цифр:
```js
const tp = new Typograf({
    locale: ['ru', 'en-US'],
    htmlEntity: {type: 'digit'}
});
tp.execute('12 кг...'); // 12 кг…
```

Все HTML-сущности готовыми символами, а невидимые сущности — в виде цифр.
Невидимые сущности — ` ` ` ` ` ` ` ` `­` `‌` `‍` `‎` `‏`.
```js
const tp = new Typograf({
    locale: ['ru', 'en-US'],
    htmlEntity: {
        type: 'name',
        onlyInvisible: true
    }
});
tp.execute('12 кг...'); // 12 кг…
```

Все HTML-сущности готовыми символами, а заданные в списке — в виде цифр:
```js
const tp = new Typograf({
    locale: ['ru', 'en-US'],
    htmlEntity: {
        type: 'digit',
        list: ['nbsp', 'shy', 'mdash', 'ndash']
    }
});
tp.execute('12 кг...'); // 12 кг…
```