Vegan Ipsum NPM Package

After installation, you can import vegan-ipsum into your JavaScript or TypeScript project to generate plant-based placeholder text programmatically.

The package supports two usage styles:

• Class-based API: ideal when you need structured, reusable configuration.
• Functional API: perfect for quick, inline text generation.

Class-Based Usage:

Import the VeganIpsum class and create an instance with configuration options. This gives you fine-grained control over sentence length, paragraph structure, and output style.

import { VeganIpsum } from "vegan-ipsum";

const vegan = new VeganIpsum({
  sentencesPerParagraph: { min: 4, max: 8 },
  wordsPerSentence: { min: 4, max: 16 },
});

// Generate one word
console.log(vegan.generateWords(1));

// Generate five sentences
console.log(vegan.generateSentences(5));

// Generate seven paragraphs
console.log(vegan.generateParagraphs(7));

Use this approach when you need consistent formatting across multiple calls or want full control over how the text is structured.

Functional Usage:

For quick and simple use cases, call the default exported function. It generates text immediately and accepts an options object for customization.

import { VeganIpsum } from "vegan-ipsum";

// Generates one sentence by default
const sentence = VeganIpsum();

// Generates custom text with advanced options
const customText = VeganIpsum({
  count: 1,
  format: "plain",        // "plain" or "html"
  paragraphLowerBound: 3,
  paragraphUpperBound: 7,
  sentenceLowerBound: 5,
  sentenceUpperBound: 15,
  random: Math.random,
  units: "sentences",     // "words", "sentences", or "paragraphs"
});

console.log(customText);

This form is best for one-off calls, CLI usage, or situations where you don't need to maintain a reusable instance.

Resources & Documentation

For comprehensive API documentation and advanced configuration options, visit the official vegan-ipsum npm package page. If you are new to open source, we recommend reading the contribution guidelines before getting started.

Developers are encouraged to explore the GitHub repository to inspect the source code. If you encounter any bugs or have suggestions for improvements, please report an issue or request a feature. Community contributions via pull requests are also welcome.