Skip to content

Fake identities generator for node.js (names, addresses, phones, IPs and others). Supports multiple languages.

License

Notifications You must be signed in to change notification settings

nodeca/charlatan

Repository files navigation

Charlatan

Build Status NPM version

Fake identities generator for node.js (names, addresses, phones, IPs and others).

This is node.js port of ruby's Faker library (v1.4.3 now), that generates fake identities for names, addresses, phone numbers, emails and others.

browserify is supported with some differences:

  • All existing languages are bundled at once.
  • Bitcoin module dropped.

API Documentation.

Installation

$ npm install charlatan

Usage

var Charlatan = require('charlatan');

var name    = Charlatan.Name.name();       // Joshua Lemke MD
var email   = Charlatan.Internet.email();  // [email protected]
var company = Charlatan.Company.name();    // Wilkinson LLC

Locales

Different countries have different data formats. Charlatan support locales as solution of this problem.

Currently available locales are here, en is default.

var Charlatan = require('charlatan');
Charlatan.setLocale('en-US');
Charlatan.Name.name();

Also you can use your own locale in yaml, json or plain hash.

var Charlatan = require('charlatan');
Charlatan.addLocale(myLocaleName, myLocaleFile);
Charlatan.setLocale(myLocaleName);
Charlatan.Name.name();

Note: If phrase not found in current locale, charlatan tries to then fallback into to base language, and then to en. For example ru-RU -> ru -> en.

Credits

Author Eugene Shkuropat

MIT license.

About

Fake identities generator for node.js (names, addresses, phones, IPs and others). Supports multiple languages.

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published