node-elizabeth v0.1.1

Description

node-elizabeth is a port of Python library elizabeth for generating dummy data for a variety of purposes. This data can be particularly useful during software development and testing. For example, it could be used to populate a testing database for a web application with user information such as email addresses, usernames, first names, last names, etc.

Installation

yarn add node-elizabeth -D

Documentation

Github pages

Basic Usage

import { Personal } from 'node-elizabeth';
// default locale is 'en'
const person = new Personal();
person.fullName({ gender: 'male' });
// Inell Britt

Locales

You can specify a locale when creating providers and they will return data that is appropriate for the language or country associated with that locale. elizabeth currently includes support for 30 different locales.

Using locales:

import { Personal } from 'node-elizabeth';

const en = new Personal();
const de = new Personal({ locale: 'de' });

en.fullName();
// Inell Britt
de.fullName();
//Sabrina Gutermuth

Port limitations

Due to JavaScript limitations there's specific method signatures - all methods take opts object as their single argument. Also first release don't include all the providers, custom providers and decorators from original library.

Running tests

npm run test

Upcoming

• Generic provider from original library
• Custom providers