nums2words-bg/README.md

Converts numbers to words in Bulgarian

# nums2wordsBG 🇧🇬
Преобразува числата в думи (converts numbers to words in Bulgarian).

## Install

```javascript
npm i nums2words-bg
```

## Usage

```javascript
import nums2wordsBG from "nums2words-bg";

nums2wordsBG("201401"); // двеста и една хиляди, четиристотин и едно

// currencies
nums2wordsBG.currency("1024.81"); // хиляда двадесет и четири лева и осемдесет и една стотинки
nums2wordsBG.currency("10122.1", {separator: ", "}); // десет хиляди, сто двадесет и два лева, десет стотинки
nums2wordsBG.currency("21001.01", { labelBig: "лв.", labelSmall: "ст." }); // двадесет и една хиляди и един лв. и една ст.
nums2wordsBG.currency("11", {displaySmall: false}); // единадесет лева
nums2wordsBG.currency("0.11", {displayBig: false}); // единадесет стотинки

nums2wordsBG.currency(".00000001", {currency: "btc"}); // нула биткойна и едно сатоши
nums2wordsBG.currency("2.01", {currency: "btc"}); // два биткойна и един милион сатоши
nums2wordsBG.currency(".208000", {currency: "btc"}); // нула биткойна и двадесет милиона и осемстотин хиляди сатоши

nums2wordsBG.currency("1.01", { currency: "cny" }); // един юан и един фен
nums2wordsBG.currency("21001.59", { currency: "cny" }); // двадесет и една хиляди и един юана и петдесет и девет фена

nums2wordsBG.currency("01.01", {currency: "rub"}); // една рубла и една копейка
nums2wordsBG.currency("21015.01", {currency: "rub"}); // двадесет и една хиляди и петнадесет рубли и една копейка

nums2wordsBG.currency("00.00", { currency: "usd" }); // нула долара и нула цента
nums2wordsBG.currency("1.99", { currency: "usd" }); // един долар и деветдесет и девет цента

// time
nums2wordsBG.time("00:01:01"); // "нула часа, една минута и една секунда"
nums2wordsBG.time("10:59:03"); // десет часа, петдесет и девет минути и три секунди
nums2wordsBG.time("1:30:4", { displayMinute: false, labelHour: "часа" }); // един часа и четири секунди

// date
nums2wordsBG.date("2 8 301", { format: "a,y,d", separator: ", " }); // два века, осем години, триста и един дена
nums2wordsBG.date("2 6", { format: "w,d" }); // две седмици и шест дена
nums2wordsBG.date("1.1.1.1", { format: "a/y/d/m", separator: ", " })); // "един век, една година, един ден, един месец"

// various units
nums2wordsBG("1", { gender: "f" }) + " вилица"; // една вилица
nums2wordsBG("1001", { gender: "m" }) + " километра"; // хиляда и един километра
nums2wordsBG("102", { gender: "m" }) + " километра"; // сто и два километра

```

Добавяне на валута:
```javascript
// define function which returns such structure:
const myCurrency = function () {
    return {
        xyz: {
            labelBig: "xyz_лева",
            labelSmall: "xyz_стотинки",
            singular: { lv: "xyz_лев", st: "xyz_стотинка" },
            decimals: 100,
            def: { lv: "m", st: "f" },
            gender: {
                1: { m: "един", f: "една" },
                2: { m: "два", f: "две" },
            },
        },
    };
};

// invoke `currency`, using the third argument (defined above)
nums2wordsBG.currency("11.01", { currency: "xyz" }, myCurrency) // единадесет xyz_лева и една xyz_стотинка
```

The library is written in vanilla JS. [Онлайн](https://vidul-nikolaev-petrov.github.io/nums2wordsBG) пример. [Повече](https://github.com/vidul-nikolaev-petrov/nums2wordsBG/tree/main/spec) примери в тестовете.