Vegan Ipsum NPM Package

Class-based usage: Import the VeganIpsum class and create an instance to generate placeholder text with custom configuration for sentence and paragraph lengths.

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));

This approach gives you fine-grained control over text structure and output style.

Functional interface: For quick and simple needs, use the default exported function to generate vegan ipsum text with customizable options passed as an object.

import { VeganIpsum } from "vegan-ipsum";

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

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

console.log(customText);

This functional form is perfect for quick inline text generation or one-off calls.