jabber
Version:
Simple random word, paragraph, lorem ipsum, dummy text generator, fake name, email.
148 lines (100 loc) • 5.07 kB
Markdown
# Jabber [](https://travis-ci.org/dejavu1987/jabber) [](https://badge.fury.io/js/jabber) [](https://coveralls.io/github/dejavu1987/jabber?branch=master) [](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md) [](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md) [](https://openbase.com/js/jabber?utm_source=embedded&utm_medium=badge&utm_campaign=rate-badge)
[](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)
Simple random word / paragraph / lorem ipsum / dummy text generator.
Supports fake name, email address.
[CodeSandbox demo](https://codesandbox.io/s/jabber-1kes7?file=/src/index.js)
## Features
- Capitalizes first letter of the sentences.
- Add theme words to make the sentences look somewhat related to a theme and not complete jabber.
- No dependencies, light weight
- Configurable density of theme words.
- Generate fake names and emails
- Add additional vowel/consonant characters to pre configured english alphabets.
## Using without installing (NPX)
Generate a word of 9 letters.
```npm
npx jabber -w 9
```
Generate a paragraph of 25 words.
```npm
npx jabber -p 25
```
## Installation
```npm
npm install jabber
```
## Usage Example
```js
const Jabber = require("jabber");
```
## Instantiate Jabber
```ts
new Jabber( themeWords: string[],
themeWordDensity: number,
extraVowels: string,
extraConsonants: string ) : Jabber
// @param themeWords — Custom words that need to appear in some density
// @param themeWordDensity — appearance of themeword 1 per this number so 5 will make it approx 1 per 5 words
// @param extraVowels — additional vowel chars
// @param extraConsonants — additional consonants
```
## Without theme words
```js
// Initialize without theme words, all the words generated will be jabber-ish
const jabber = new Jabber();
// Create a 6 letter word
jabber.createWord(6); //"cubaci"
// Set second param to true to capitalize first letter
jabber.createWord(5, true); //"Ribah"
jabber.createFullName(); // 'Ms. Negu Komi',
const nameNoSalutation = jabber.createFullName(false); // 'Mobosek Teqigeg'
jabber.createEmail(); // 'loddla.noyec@domain.com'
const emailWithCustomDomain = jabber.createEmail("jabber.com"); // 'ticu.lebec@jabber.com'
// create a paragraph of 30 words
jabber.createParagraph(30);
/* "Pahodu decodifo qudel dociriveh. Kadunebob ki vuxo wu cene… Maru lucuzac kogimag mubav roxe cutosimuh. Ce pukicexin." */
```
## Usage with theme words
```js
// Define Theme Words that will appear randomly in the text
const themeWords = [
"Content curation",
"Engagement",
"Embedding",
"Impressions",
"Influencer",
"Mentions",
"Microblogging",
"Organic",
"Reach",
"Social graph",
"User-generated content (UGC)",
"Affiliate marketing",
"Bounce rate",
"Call to Action (CTA)",
"Click through rate (CTR)",
"SDK (Software Development Kit)",
"Web apps",
];
/*
Initialize passing in themewords and density of themeword
1 being only themewords (100%)
100 meaning 1 out of 100 words (1%)
Lets use 2 which means every other word (50%) is a theme word
*/
let jabber = new Jabber(themeWords, 2);
// Create a 6 letter word (Capitalized)
// createWord might return themeword which will not care about length
jabber.createWord(6, true); // "Pamulo"
// create a paragraph of 50 words
jabber.createParagraph(50);
// See below the result
```
## Result
Limebojetu Pixels per Inch (PPI) cico Selector. Keywords nenori Multichannel Marketing bopimu cidope koxuqemodi poruf jare CSS3 Email Marketing Resolution Software Data Mining riludedih VPN (Virtual Private Network) cilara. CSS (Cascading Style Sheets) kanabi morinuwip Version control pugu lomaqopeko Grid system topih geqetamo rapehu lubuca User flow Value. Lub Mentions kimadiqubu kefic. Yibon dedu. Li. Reach Property tijacodur. Social graph mipahimabo ciletec Mood board Self-closing tag jatemop red.
## Performance
Since Jabber is extreamly light weight, it is very performant.
## Changelog
v.1.5.1 TypeScript support - [DEMO](https://stackblitz.com/edit/jabber-typescript?file=index.ts)