shevchenko.js

JavaScript library for declension of Ukrainian anthroponyms.


Links

* Try it out / Демонстрація
* API Specification
* Source Code
* License
* Migration Guide (v2 → v3)

Extensions

* Military extension - declension of Ukrainian military ranks and appointments

User Guide

$3

#### npm

To install the library using npm package manager, use the following command:

``bash
npm install --save shevchenko
`

$3

The library comes in three formats: CommonJS module, ECMAScript module, and a minified UMD bundle. You can select the format that best suits your needs.

#### CommonJS

To import the library as a CommonJS module, use the following code:

`JavaScript
const shevchenko = require('shevchenko');
`

#### ECMAScript

To import the library as an ECMAScript module, use the following code:

`JavaScript
import * as shevchenko from 'shevchenko';
`

#### UMD

To import the library as a UMD bundle, include the following script tag in your HTML code:

`HTML
<‍script type="text/javascript" src="https://unpkg.com/shevchenko"><‍/script>
`

$3

#### Personal names declension

This example shows how to use the library to decline Ukrainian anthroponyms.

`JavaScript
const shevchenko = require('shevchenko');

async function main() {
const input = {
gender: 'masculine',
givenName: 'Тарас',
patronymicName: 'Григорович',
familyName: 'Шевченко'
};

const output = await shevchenko.inVocative(input);

console.log(output); // { givenName: "Тарасе", patronymicName: "Григоровичу", familyName: "Шевченку" }
}

main().catch((error) => console.error(error));
`

#### Automatic grammatical gender detection

This example shows how to use the library to automatically detect the grammatical gender of a Ukrainian anthroponym.

`JavaScript
const shevchenko = require('shevchenko');

async function main() {
const anthroponym = {
givenName: 'Лариса',
patronymicName: 'Петрівна',
familyName: 'Косач-Квітка'
};

const gender = await shevchenko.detectGender(anthroponym); // "feminine"
if (gender == null) {
throw new Error('Failed to detect grammatical gender.');
}

const input = { ...anthroponym, gender };

const output = await shevchenko.inVocative(input);

console.log(output); // { givenName: "Ларисо", patronymicName: "Петрівно", familyName: "Косач-Квітко" }
}

main().catch((error) => console.error(error));
``

#### Usage via HTTP API

The library can be integrated into your project via HTTP API. Please refer to shevchenko Docker image for the additional instructions.