number-to-georgian-text/README.md

This package is for converting numbers to Georgian text.

# number-to-georgian-text
Convert numbers into Georgian words

## Installation

#### NPM
```shell
npm install number-to-georgian-text --save
```

#### Yarn
```shell
yarn add number-to-georgian-text
```

## Usage

### To Text
```typescript
import { numberToText } from 'number-to-georgian-text';

console.log(numberToText(1700055));
// ერთი მილიონ შვიდასი ათას ორმოცდათხუთმეტი
console.log(numberToText("1700055"));
// ერთი მილიონ შვიდასი ათას ორმოცდათხუთმეტი
console.log(numberToText(1001001, {leadingOne: true}));
// ერთი მილიონ ერთი ათას ერთი
console.log(numberToText(1001001, {leadingOne: false}));
// მილიონ ათას ერთი
console.log(numberToText(100.01));
// ასი მთელი ერთი მეასედი
console.log(numberToText(100.01, {decimalPointSeparator: ','}));
// ასი მთელი, ერთი მეასედი
console.log(numberToText(100.01, {decimalPointSeparator: ' და'}));
// ასი მთელი და ერთი მეასედი
```

### To Ordinal
```typescript
import { numberToOrdinal } from 'number-to-georgian-text';

console.log(numberToOrdinal(1));
// 1-ელი
console.log(numberToOrdinal(2));
// მე-2
console.log(numberToOrdinal(1005));
// 1005-ე
```

### To Ordinal Text
```typescript
import { numberToOrdinalText } from 'number-to-georgian-text';

console.log(numberToOrdinalText(1));
// პირველი
console.log(numberToOrdinalText(2));
// მეორე
console.log(numberToOrdinalText(1005));
// ათას მეხუთე
```

## Options
```typescript
type Options = {
    leadingOne?: boolean; // default: true
    decimalPointSeparator?: string; // default: ''
}
```

## Tests
```shell
npm test
```

## License
MIT