lorelai

Documentation

Overview

Provides Random Lorem Ipsum, and other utilities.

Index

• Variables
• func ClassicParagraph() string
• func ClassicSentence() string
• func ClassicWords(quantity int) string
• func ClassicWordsPerParagraph() int
• func ClassicWordsPerSentence() int
• func Domain() string
• func Email() string
• func FormattedLoremWords(quantity int) string
• func LoremWords(quantity int) string
• func Paragraph() string
• func Sentence() string
• func Title() string
• func URL() string
• func Word() string
• type Lorem
  • func ClassicGenerate(paragraphs int, sentences int) Lorem
  • func Generate(paragraphs int, sentences int) Lorem

Variables

var DATA [1100]string = [1100]string{} /* 1100 elements not displayed */

A lot of Lorem Ipsum Words.

var TLDS = []string{

	"com",
	"net",
	"org",
	"fr",
	"de",
	"uk",
	"cn",
	"ru",
	"br",
	"in",
	"jp",
	"ca",
	"us",
	"it",
	"au",
	"es",
	"nl",
	"se",
	"mx",
	"ch",
	"pl",
	"ar",
	"be",
	"no",
	"at",
	"dk",
	"fi",
	"pe",

	"io",
	"co",
	"ai",
	"tv",
	"me",
	"app",
	"dev",
	"xyz",
	"biz",
	"pro",
}

Functions

func ClassicParagraph

func ClassicParagraph() string

ClassicParagraph returns the classic Lorem Ipsum paragraph that starts with "Lorem ipsum dolor sit amet, consectetur adipiscing elit..."

func ClassicSentence

func ClassicSentence() string

ClassicSentence returns a sentence from the classic Lorem Ipsum text

func ClassicWords

func ClassicWords(quantity int) string

ClassicWords returns the specified number of words from the classic Lorem Ipsum text

func ClassicWordsPerParagraph

func ClassicWordsPerParagraph() int

ClassicWordsPerSentence returns the word count per praragraph

func ClassicWordsPerSentence

func ClassicWordsPerSentence() int

ClassicWordsPerSentence returns the word count per sentence

func Domain

func Domain() string

Get a random Domain

func Email

func Email() string

Get a random email

func FormattedLoremWords

func FormattedLoremWords(quantity int) string

Get [quantity] words, the first word is capitalized, ends with a dot.

func LoremWords

func LoremWords(quantity int) string

Get [quantity] words

func Paragraph

func Paragraph() string

Get a paragraph, with the first word capitalized, of forty five words that ends with a dot.

func Sentence

func Sentence() string

Get a sentence, with the first word capitalized, of eight words that ends with a dot.

func Title

func Title() string

func URL

func URL() string

Get a random URL

func Word

func Word() string

Get a single word

Types

type Lorem

type Lorem struct {
	Text       string
	Paragraphs int
	Sentences  int
	WordCount  int
}

Lorem represents generated Lorem Ipsum text with metadata

func ClassicGenerate

func ClassicGenerate(paragraphs int, sentences int) Lorem

ClassicGenerate creates classic Lorem Ipsum text with specified paragraphs and sentences. Each paragraph contains exactly 'sentences' sentences. Each sentence contains 8 words from the classic Lorem Ipsum text.

Example: ClassicGenerate(3, 5) creates 3 paragraphs, each with 5 sentences.

This differs from the CLI behavior where -p and -s are additive.

func Generate

func Generate(paragraphs int, sentences int) Lorem

Generate creates Lorem Ipsum text with specified paragraphs and sentences. Each paragraph contains exactly 'sentences' sentences. Each sentence contains 8 random words.

Example: Generate(3, 5) creates 3 paragraphs, each with 5 sentences.

This differs from the CLI behavior where -p and -s are additive.