Skip to content

elfexor/russian_name

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This package perfect for prototyping stuff or examples of real russian names.

Usage

Install the package using npm and save it to the dependency list:

npm install --save russian_name

Usage example:

import { russianName } from 'russian_name';
// or
const { russianName } = require('russian_name');

russianName.one('female');
// or
russianName.many(10, 'male');

Result example:

{
    "gender": "male",
    "name": "Евельян",
    "surname": "Митронин",
    "fullname": "Евельян Митронин",
    "transliteration": {
      "name": "Evelyan",
      "surname": "Mitronin",
      "fullname": "Evelyan Mitronin"
    }
}

Configuration

russianName.one(gender); 
russianName.many(amount, gender);

Here's the full list of all available options:

Name Description Type
gender Limit results to the male or female gender String
amount Amount of names to return (only for .many method) Integer

Test

npm run test