We all have funny mates, right?
JavaScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
src
tests
.editorconfig
.gitignore
LICENSE
README.md
karma.conf.js
package.json
webpack.config.js

README.md

wizipsum

We all have funny mates, right?

Introduction

Surely, Khaled has some cool slangs but we all have funny mates so why couldn't we build our own lorem ipsum? That's what wizipsum is: a lorem ipsum generator builder. It's dead simple, tested and easy to get started.

DIY

If you want to build your own lorem ipsum without worrying about hosting while being able to use it everywhere thanks to the chrome extension, head to the demo ;).

Installation

  1. Get it via:
const wizipsum = require('wizipsum')
const generator = wizipsum(['Fill this array', 'with any slangs', 'you want'])

console.log(generator())

Documentation

wizipsum is a function that accepts only one argument and returns the api.

Arguments

  1. strs (required) - An array of strings

Example

const wizipsum = require('wizipsum')
const generator = wizipsum(['Some string there.', 'And some more here.'])

API

.paragraph(nb = 1, wrappers = ['', '\n\n'], averageLength = 400)

Returns a number of paragraphs composed of random strings (from strs).

Arguments

  1. nb (default: 1) - The number of paragraphs to generate.
  2. wrappers (default: ['', '\n\n']) - The first item will be added to the start of each paragraphs while the second is added to the end.
  3. averageLength (default: 400) - The average length of each paragraphs.

Example

const wizipsum = require('wizipsum')
const generator = wizipsum(['Some string there.', 'And some more here.'])

generator.paragraph(2, ['<p>', '</p>'], 30)
// '<p>Some string there. And some more here.</p><p>And some more here. And some more here.</p>'

.sentence(nb = 1, wrappers = ['', ' '])

Returns a number of sentences composed of random strings (from strs).

Arguments

  1. nb (default: 1) - The number of sentences to generate.
  2. wrappers (default: ['', ' ']) - The first item will be added to the start of each sentences while the second is added to the end.

Example

const wizipsum = require('wizipsum')
const generator = wizipsum(['Some string there.', 'And some more here.'])

generator.sentence(2, ['<p>', '</p>'])
// '<p>Some string there.</p><p>And some more here.</p>'

.title(nb = 1, wrappers = ['', ' '])

Title actually calls sentence and upper case every starting letter.

Arguments

  1. nb (default: 1) - The number of titles to generate.
  2. wrappers (default: ['', ' ']) - The first item will be added to the start of each titles while the second is added to the end.

Example

const wizipsum = require('wizipsum')
const generator = wizipsum(['Some string there.', 'And some more here.'])

generator.title(2, ['<p>', '</p>'])
// '<p>Some String There.</p><p>And Some More Here.</p>'

.word(nb = 1, wrappers = ['', ' '])

Returns a number of words composed of random strings (from strs). Note: the words are also lower cased and every non alphanumeric characters are removed (except for the "-"). Which makes this function great if you want to generate hashtags-like words (use the ['#', ' '] wrappers and you're good).

Arguments

  1. nb (default: 1) - The number of words to generate.
  2. wrappers (default: ['', ' ']) - The first item will be added to the start of each words while the second is added to the end.

Example

const wizipsum = require('wizipsum')
const generator = wizipsum(['Some string there.', 'And some more here.'])

generator.word(3, ['<strong>', '<strong>'])
// '<strong>string</strong><strong>some</strong><strong>there</strong>'