Polish numeral parser JS

polish-numeral-parser-js is a JavaScript library used to parse verbal numbers in Polish into JS number values. It was created primarily for the purpose of parsing amounts written in words.

Installation

npm install --save @arczinosek/polish-numeral-parser

Usage

parseVerbalNumberPl

It parses given string and returns a number value. By default it skips unknown words.

import { parseVerbalNumberPl } from '@arczinosek/polish-numeral-parser';

const value = parseVerbalNumberPl(
  'sto dwadzieścia trzy tysiące czterysta pięćdziesiąt sześć złotych siedemdziesiąt osiem groszy',
);
// value: 123456.78

Set the second parameter to false to generate an UnknownWordError when an unknown word is encountered.

import { parseVerbalNumberPl } from '@arczinosek/polish-numeral-parser';

const value = parseVerbalNumberPl('jeden foo dwa bar', false);

// throws UnknownWordError with `word: string` and `sentence: string` properties.
// Property `word` contais only first unrecognized word.

NUMBERS_DICTIONARY

An array of all words that can be recognized (after normalization).

import { NUMBERS_DICTIONARY } from '@arczinosek/polish-numeral-parser';

console.log(NUMBERS_DICTIONARY);

// [
//   'zero',             'jeden',              'jednego',
//   'dziesiec',         'dziesieciu',         'jedenascie',
// ...

stripPolishDiacritics

Replaces all polish diacritics with non-diacritic equivalents.

import { stripPolishDiacritics } from '@arczinosek/polish-numeral-parser';

const stripped = stripPolishDiacritics('ĄĆĘŁŃÓŚŻŹąćęłńóśżź');

// stripped: ACELNOSZZacelnoszz

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT