1 | [![All dependencies](https://img.shields.io/librariesio/release/npm/verbal-time/2.0.4?label=all%20dependencies)](https://libraries.io/npm/verbal-time/2.0.4)
|
2 | [![Vulnerabilities](https://snyk.io/test/npm/verbal-time/2.0.4/badge.svg)](https://snyk.io/test/npm/verbal-time/2.0.4)
|
3 | [![Install size](https://packagephobia.now.sh/badge?p=verbal-time@2.0.4)](https://packagephobia.now.sh/result?p=verbal-time@2.0.4)
|
4 | [![NPM-version](https://img.shields.io/badge/npm-v2.0.4-blue.svg)](https://www.npmjs.com/package/verbal-time/v/2.0.4)
|
5 | [![Total downloads](https://img.shields.io/npm/dt/verbal-time?label=total%20downloads)](https://npm-stat.com/charts.html?package=verbal-time)
|
6 |
|
7 | # verbal-time@2.0.4
|
8 |
|
9 | Spells time with words. Supports only **Russian** and **Ukrainian** languages.
|
10 |
|
11 | ## Installation
|
12 | `verbal-time` is available via npm:
|
13 | ``` bash
|
14 | $ npm i verbal-time@2.0.4
|
15 | ```
|
16 |
|
17 | ## Usage
|
18 | ### Basic
|
19 | ``` js
|
20 | const verbalTime = require('verbal-time');
|
21 |
|
22 | console.log(verbalTime(new Date('2019-09-27 12:00'))); // Полдень
|
23 | console.log(verbalTime(new Date('2019-09-27 12:20'))); // 20 минут первого
|
24 | console.log(verbalTime(new Date('2019-09-27 17:50'))); // Без 10 шесть
|
25 | console.log(verbalTime(new Date('2019-09-27 06:30'))); // Половина седьмого
|
26 | ```
|
27 |
|
28 | ### With configuration
|
29 | ``` js
|
30 | const verbalTime = require('verbal-time')({ lang: 'ua' });
|
31 |
|
32 | console.log(verbalTime(new Date('2019-09-27 15:00'))); // Третя дня
|
33 | console.log(verbalTime(new Date('2019-09-27 19:20'))); // 20 хвилин на восьму
|
34 | console.log(verbalTime(new Date('2019-09-27 06:30'))); // Пів на сьому
|
35 | console.log(verbalTime(new Date('2019-09-27 16:40'))); // За 20 п'ята
|
36 |
|
37 | verbalTime({ spellCountDownMinutes: true });
|
38 | console.log(verbalTime(new Date('2019-09-27 16:40'))); // За 20 хвилин п'ята
|
39 | ```
|
40 |
|
41 | ## Configuration properties
|
42 | `lang`: 'ru' or 'ua' (default **'ru'**) — Russian or Ukrainian text language.
|
43 |
|
44 | `countDownFrom`: 0..60 (default **30**) — the first minute that begins to be like in example.
|
45 | ### Example
|
46 | ``` js
|
47 | const verbalTime = require('verbal-time')({ countDownFrom: 35 });
|
48 |
|
49 | console.log(verbalTime(new Date('2019-09-27 16:34'))); // 34 минуты пятого
|
50 | console.log(verbalTime(new Date('2019-09-27 16:35'))); // Без 25 пять
|
51 | ```
|
52 |
|
53 | `spellCountDownMinutes`: Boolean (default **false**).
|
54 | ### Example
|
55 | ``` js
|
56 | const verbalTime = require('verbal-time');
|
57 |
|
58 | console.log(verbalTime(new Date('2019-09-27 21:53'))); // Без 7 десять
|
59 |
|
60 | verbalTime({ spellCountDownMinutes: true });
|
61 | console.log(verbalTime(new Date('2019-09-27 21:53'))); // Без 7 минут десять
|
62 | ```
|
63 |
|
64 | `spellLastMinuteAsWord`: Boolean (default **true**) — to spell "1" or "минуты" last minute every hour.
|
65 | ### Example
|
66 | ``` js
|
67 | const verbalTime = require('verbal-time');
|
68 |
|
69 | console.log(verbalTime(new Date('2019-09-27 21:59'))); // Без минуты десять
|
70 |
|
71 | verbalTime({ spellLastMinuteAsWord: false });
|
72 | console.log(verbalTime(new Date('2019-09-27 21:59'))); // Без 1 десять
|
73 | ```
|
74 |
|
75 | ## Testing
|
76 | No testing functionality provided.
|
77 |
|
78 | ---
|
79 |
|
80 | Your improve suggestions and bug reports are welcome any time.
|