Skip to main content

lorem Domain

The lorem domain maps domain keywords to underlying faker implementations.

Faker Documentation

Methods

lorem.lines

Generates the given number lines of lorem separated by '\n'.

ArgTypeRequiredDescription
minnumbernoMinimum bound used when generating a value.
maxnumbernoMaximum bound used when generating a value.
lineCountnumbernoExact number of lines to generate.
lineCountMaxnumbernoThe maximum number of lines to generate.
lineCountMinnumbernoThe minimum number of lines to generate.

Examples:

Shows lorem.lines when optional params are omitted.

lorem.lines()

Returns: A cognatus arca aliquam audentia coniuratio crux fugit.\nStillicidium bardus utrimque acsi spargo cur.\nAqua avaritia thesaurus volo combibo stultus utor.

Shows lorem.lines using min.

lorem.lines(max=10, min=1)

Returns: A cognatus arca aliquam audentia coniuratio crux fugit.\nStillicidium bardus utrimque acsi spargo cur.\nAqua avaritia thesaurus volo combibo stultus utor.\nAgo adflicto assentator utrimque altus curiositas vita expedita stultus comedo.\nTrucido accusamus tandem voveo tamisium cicuta testimonium amet.

Shows lorem.lines using max.

lorem.lines(max=5)

Returns: A cognatus arca aliquam audentia coniuratio crux fugit.\nStillicidium bardus utrimque acsi spargo cur.\nAqua avaritia thesaurus volo combibo stultus utor.

Shows lorem.lines using lineCount.

lorem.lines(lineCount=5)

Returns: Suppellex a cognatus arca aliquam audentia.\nCrux fugit curatio stillicidium bardus.\nAcsi spargo cur laboriosam aqua avaritia thesaurus volo combibo stultus.\nVarius ago adflicto assentator utrimque altus curiositas vita expedita stultus.\nStipes trucido accusamus tandem voveo.

Shows lorem.lines using lineCountMax.

lorem.lines(lineCountMax=5)

Returns: A cognatus arca aliquam audentia coniuratio crux fugit.\nStillicidium bardus utrimque acsi spargo cur.\nAqua avaritia thesaurus volo combibo stultus utor.

Shows lorem.lines using lineCountMin.

lorem.lines(lineCountMin=5)

Returns: Suppellex a cognatus arca aliquam audentia.\nCrux fugit curatio stillicidium bardus.\nAcsi spargo cur laboriosam aqua avaritia thesaurus volo combibo stultus.\nVarius ago adflicto assentator utrimque altus curiositas vita expedita stultus.\nStipes trucido accusamus tandem voveo.

lorem.paragraph

Generates a paragraph with the given number of sentences.

ArgTypeRequiredDescription
minnumbernoMinimum bound used when generating a value.
maxnumbernoMaximum bound used when generating a value.
sentenceCountnumbernoNumber of sentences to generate.
sentenceCountMaxnumbernoThe maximum number of sentences to generate.
sentenceCountMinnumbernoThe minimum number of sentences to generate.

Examples:

Shows lorem.paragraph when optional params are omitted.

lorem.paragraph()

Returns: Suppellex a cognatus arca aliquam audentia. Crux fugit curatio stillicidium bardus. Acsi spargo cur laboriosam aqua avaritia thesaurus volo combibo stultus.

Shows lorem.paragraph using min.

lorem.paragraph(max=10, min=1)

Returns: A cognatus arca aliquam audentia coniuratio crux fugit. Stillicidium bardus utrimque acsi spargo cur. Aqua avaritia thesaurus volo combibo stultus utor. Ago adflicto assentator utrimque altus curiositas vita expedita stultus comedo. Trucido accusamus tandem voveo tamisium cicuta testimonium amet.

Shows lorem.paragraph using max.

lorem.paragraph(max=5)

Returns: A cognatus arca aliquam audentia coniuratio crux fugit. Stillicidium bardus utrimque acsi spargo cur. Aqua avaritia thesaurus volo combibo stultus utor.

Shows lorem.paragraph using sentenceCount.

lorem.paragraph(sentenceCount=5)

Returns: Suppellex a cognatus arca aliquam audentia. Crux fugit curatio stillicidium bardus. Acsi spargo cur laboriosam aqua avaritia thesaurus volo combibo stultus. Varius ago adflicto assentator utrimque altus curiositas vita expedita stultus. Stipes trucido accusamus tandem voveo.

Shows lorem.paragraph using sentenceCountMax.

lorem.paragraph(sentenceCountMax=5)

Returns: A cognatus arca aliquam audentia coniuratio crux fugit. Stillicidium bardus utrimque acsi spargo cur. Aqua avaritia thesaurus volo combibo stultus utor.

Shows lorem.paragraph using sentenceCountMin.

lorem.paragraph(sentenceCountMin=5)

Returns: Suppellex a cognatus arca aliquam audentia. Crux fugit curatio stillicidium bardus. Acsi spargo cur laboriosam aqua avaritia thesaurus volo combibo stultus. Varius ago adflicto assentator utrimque altus curiositas vita expedita stultus. Stipes trucido accusamus tandem voveo.

lorem.paragraphs

Generates the given number of paragraphs.

ArgTypeRequiredDescription
minnumbernoMinimum bound used when generating a value.
maxnumbernoMaximum bound used when generating a value.
paragraphCountnumbernoNumber of paragraphs to generate.
separatorstringnoSeparator inserted between generated items.
paragraphCountMaxnumbernoThe maximum number of paragraphs to generate.
paragraphCountMinnumbernoThe minimum number of paragraphs to generate.

Examples:

Shows lorem.paragraphs when optional params are omitted.

lorem.paragraphs()

Returns: Suppellex a cognatus arca aliquam audentia. Crux fugit curatio stillicidium bardus. Acsi spargo cur laboriosam aqua avaritia thesaurus volo combibo stultus.\nVarius ago adflicto assentator utrimque altus curiositas vita expedita stultus. Stipes trucido accusamus tandem voveo. Cicuta testimonium amet dedico ver claudeo civis aperio.\nSpoliatio beneficium cena. Adnuo natus arca odit subseco ambulo. Suasoria cupio admiratio facilis sonitus dolorum.

Shows lorem.paragraphs using min.

lorem.paragraphs(max=10, min=1)

Returns: A cognatus arca aliquam audentia coniuratio crux fugit. Stillicidium bardus utrimque acsi spargo cur. Aqua avaritia thesaurus volo combibo stultus utor.\nAgo adflicto assentator utrimque altus curiositas vita expedita stultus comedo. Trucido accusamus tandem voveo tamisium cicuta testimonium amet. Ver claudeo civis aperio accusantium spoliatio.\nCena deprimo adnuo natus. Odit subseco ambulo cupio. Cupio admiratio facilis sonitus dolorum vinco occaecati venio.\nApud timor cubicularis asperiores. Conqueror tantillus sursum vacuus quia tantillus conscendo centum vehemens cursus. Somnus quasi amplus vir defaeco nesciunt cumque capillus venio natus.\nProvident compello et. Consuasor ver qui accendo vetus studio vulpes at approbo vicissitudo. Aedificium temeritas tego vesica sum ante accusantium acquiro.

Shows lorem.paragraphs using max.

lorem.paragraphs(max=5)

Returns: A cognatus arca aliquam audentia coniuratio crux fugit. Stillicidium bardus utrimque acsi spargo cur. Aqua avaritia thesaurus volo combibo stultus utor.\nAgo adflicto assentator utrimque altus curiositas vita expedita stultus comedo. Trucido accusamus tandem voveo tamisium cicuta testimonium amet. Ver claudeo civis aperio accusantium spoliatio.\nCena deprimo adnuo natus. Odit subseco ambulo cupio. Cupio admiratio facilis sonitus dolorum vinco occaecati venio.

Shows lorem.paragraphs using paragraphCount.

lorem.paragraphs(paragraphCount=5)

Returns: Suppellex a cognatus arca aliquam audentia. Crux fugit curatio stillicidium bardus. Acsi spargo cur laboriosam aqua avaritia thesaurus volo combibo stultus.\nVarius ago adflicto assentator utrimque altus curiositas vita expedita stultus. Stipes trucido accusamus tandem voveo. Cicuta testimonium amet dedico ver claudeo civis aperio.\nSpoliatio beneficium cena. Adnuo natus arca odit subseco ambulo. Suasoria cupio admiratio facilis sonitus dolorum.\nOccaecati venio apto apud timor cubicularis asperiores vestigium conqueror tantillus. Vacuus quia tantillus conscendo centum vehemens cursus vobis. Quasi amplus vir defaeco nesciunt cumque capillus venio.\nAbbas provident compello et valde consuasor ver. Accendo vetus studio vulpes at approbo vicissitudo. Aedificium temeritas tego vesica sum ante accusantium acquiro.

Shows lorem.paragraphs using separator.

lorem.paragraphs(separator="-")

Returns: Suppellex a cognatus arca aliquam audentia. Crux fugit curatio stillicidium bardus. Acsi spargo cur laboriosam aqua avaritia thesaurus volo combibo stultus.-Varius ago adflicto assentator utrimque altus curiositas vita expedita stultus. Stipes trucido accusamus tandem voveo. Cicuta testimonium amet dedico ver claudeo civis aperio.-Spoliatio beneficium cena. Adnuo natus arca odit subseco ambulo. Suasoria cupio admiratio facilis sonitus dolorum.

Shows lorem.paragraphs using paragraphCountMax.

lorem.paragraphs(paragraphCountMax=5)

Returns: A cognatus arca aliquam audentia coniuratio crux fugit. Stillicidium bardus utrimque acsi spargo cur. Aqua avaritia thesaurus volo combibo stultus utor.\nAgo adflicto assentator utrimque altus curiositas vita expedita stultus comedo. Trucido accusamus tandem voveo tamisium cicuta testimonium amet. Ver claudeo civis aperio accusantium spoliatio.\nCena deprimo adnuo natus. Odit subseco ambulo cupio. Cupio admiratio facilis sonitus dolorum vinco occaecati venio.

Shows lorem.paragraphs using paragraphCountMin.

lorem.paragraphs(paragraphCountMin=5)

Returns: Suppellex a cognatus arca aliquam audentia. Crux fugit curatio stillicidium bardus. Acsi spargo cur laboriosam aqua avaritia thesaurus volo combibo stultus.\nVarius ago adflicto assentator utrimque altus curiositas vita expedita stultus. Stipes trucido accusamus tandem voveo. Cicuta testimonium amet dedico ver claudeo civis aperio.\nSpoliatio beneficium cena. Adnuo natus arca odit subseco ambulo. Suasoria cupio admiratio facilis sonitus dolorum.\nOccaecati venio apto apud timor cubicularis asperiores vestigium conqueror tantillus. Vacuus quia tantillus conscendo centum vehemens cursus vobis. Quasi amplus vir defaeco nesciunt cumque capillus venio.\nAbbas provident compello et valde consuasor ver. Accendo vetus studio vulpes at approbo vicissitudo. Aedificium temeritas tego vesica sum ante accusantium acquiro.

lorem.sentence

Generates a space separated list of words beginning with a capital letter and ending with a period.

ArgTypeRequiredDescription
minnumbernoMinimum bound used when generating a value.
maxnumbernoMaximum bound used when generating a value.
wordCountnumbernoNumber of words to generate.
wordCountMaxnumbernoThe maximum number of words to generate.
wordCountMinnumbernoThe minimum number of words to generate.

Examples:

Shows lorem.sentence when optional params are omitted.

lorem.sentence()

Returns: Suppellex a cognatus arca aliquam audentia.

Shows lorem.sentence using min.

lorem.sentence(max=10, min=1)

Returns: Suppellex a cognatus arca aliquam.

Shows lorem.sentence using max.

lorem.sentence(max=5)

Returns: Suppellex a cognatus.

Shows lorem.sentence using wordCount.

lorem.sentence(wordCount=5)

Returns: Cur suppellex a cognatus arca.

Shows lorem.sentence using wordCountMax.

lorem.sentence(wordCountMax=5)

Returns: Suppellex a cognatus.

Shows lorem.sentence using wordCountMin.

lorem.sentence(wordCountMin=5)

Returns: Cur suppellex a cognatus arca.

lorem.sentences

Generates the given number of sentences.

ArgTypeRequiredDescription
minnumbernoMinimum bound used when generating a value.
maxnumbernoMaximum bound used when generating a value.
sentenceCountnumbernoNumber of sentences to generate.
separatorstringnoSeparator inserted between generated items.
sentenceCountMaxnumbernoThe maximum number of sentences to generate.
sentenceCountMinnumbernoThe minimum number of sentences to generate.

Examples:

Shows lorem.sentences when optional params are omitted.

lorem.sentences()

Returns: A cognatus arca aliquam audentia coniuratio crux fugit. Stillicidium bardus utrimque acsi spargo cur. Aqua avaritia thesaurus volo combibo stultus utor. Ago adflicto assentator utrimque altus curiositas vita expedita stultus comedo.

Shows lorem.sentences using min.

lorem.sentences(max=10, min=1)

Returns: A cognatus arca aliquam audentia coniuratio crux fugit. Stillicidium bardus utrimque acsi spargo cur. Aqua avaritia thesaurus volo combibo stultus utor. Ago adflicto assentator utrimque altus curiositas vita expedita stultus comedo. Trucido accusamus tandem voveo tamisium cicuta testimonium amet.

Shows lorem.sentences using max.

lorem.sentences(max=5)

Returns: A cognatus arca aliquam audentia coniuratio crux fugit. Stillicidium bardus utrimque acsi spargo cur. Aqua avaritia thesaurus volo combibo stultus utor.

Shows lorem.sentences using sentenceCount.

lorem.sentences(sentenceCount=5)

Returns: Suppellex a cognatus arca aliquam audentia. Crux fugit curatio stillicidium bardus. Acsi spargo cur laboriosam aqua avaritia thesaurus volo combibo stultus. Varius ago adflicto assentator utrimque altus curiositas vita expedita stultus. Stipes trucido accusamus tandem voveo.

Shows lorem.sentences using separator.

lorem.sentences(separator="-")

Returns: A cognatus arca aliquam audentia coniuratio crux fugit.-Stillicidium bardus utrimque acsi spargo cur.-Aqua avaritia thesaurus volo combibo stultus utor.-Ago adflicto assentator utrimque altus curiositas vita expedita stultus comedo.

Shows lorem.sentences using sentenceCountMax.

lorem.sentences(sentenceCountMax=5)

Returns: A cognatus arca aliquam audentia coniuratio crux fugit. Stillicidium bardus utrimque acsi spargo cur. Aqua avaritia thesaurus volo combibo stultus utor.

Shows lorem.sentences using sentenceCountMin.

lorem.sentences(sentenceCountMin=5)

Returns: Suppellex a cognatus arca aliquam audentia. Crux fugit curatio stillicidium bardus. Acsi spargo cur laboriosam aqua avaritia thesaurus volo combibo stultus. Varius ago adflicto assentator utrimque altus curiositas vita expedita stultus. Stipes trucido accusamus tandem voveo.

lorem.slug

Generates a slugified text consisting of the given number of hyphen separated words.

ArgTypeRequiredDescription
minnumbernoMinimum bound used when generating a value.
maxnumbernoMaximum bound used when generating a value.
wordCountnumbernoNumber of words to generate.
wordCountMaxnumbernoThe maximum number of words to generate.
wordCountMinnumbernoThe minimum number of words to generate.

Examples:

Shows lorem.slug when optional params are omitted.

lorem.slug()

Returns: cur-suppellex-a

Shows lorem.slug using min.

lorem.slug(max=10, min=1)

Returns: suppellex-a-cognatus-arca-aliquam

Shows lorem.slug using max.

lorem.slug(max=5)

Returns: suppellex-a-cognatus

Shows lorem.slug using wordCount.

lorem.slug(wordCount=5)

Returns: cur-suppellex-a-cognatus-arca

Shows lorem.slug using wordCountMax.

lorem.slug(wordCountMax=5)

Returns: suppellex-a-cognatus

Shows lorem.slug using wordCountMin.

lorem.slug(wordCountMin=5)

Returns: cur-suppellex-a-cognatus-arca

lorem.text

Generates a random text based on a random lorem method.

No parameters.

Examples:

Shows the default lorem.text call.

lorem.text

Returns: A cognatus arca aliquam audentia coniuratio crux fugit. Stillicidium bardus utrimque acsi spargo cur. Aqua avaritia thesaurus volo combibo stultus utor.

lorem.word

Generates a word of a specified length.

ArgTypeRequiredDescription
lengthnumbernoExact word length to generate.
strategyfail|closest|shortest|longest|any-lengthnoThe strategy to apply when no words with a matching length are found. Available error handling strategies: fail: Throws an error if no words with the given length are found. shortest: Returns any of the shortest words. closest: Returns any of the words closest to the given length. longest: Returns any of the longest words. any-length: Returns a word with any length.

Examples:

Shows lorem.word when optional params are omitted.

lorem.word()

Returns: cur

Shows lorem.word using length.

lorem.word(length=5)

Returns: curvo

Shows lorem.word using strategy.

lorem.word(strategy="any-length")

Returns: cur

lorem.words

Generates a space separated list of words.

ArgTypeRequiredDescription
minnumbernoMinimum bound used when generating a value.
maxnumbernoMaximum bound used when generating a value.
wordCountnumbernoNumber of words to generate.
wordCountMaxnumbernoThe maximum number of words to generate.
wordCountMinnumbernoThe minimum number of words to generate.

Examples:

Shows lorem.words when optional params are omitted.

lorem.words()

Returns: cur suppellex a

Shows lorem.words using min.

lorem.words(max=10, min=1)

Returns: suppellex a cognatus arca aliquam

Shows lorem.words using max.

lorem.words(max=5)

Returns: suppellex a cognatus

Shows lorem.words using wordCount.

lorem.words(wordCount=5)

Returns: cur suppellex a cognatus arca

Shows lorem.words using wordCountMax.

lorem.words(wordCountMax=5)

Returns: suppellex a cognatus

Shows lorem.words using wordCountMin.

lorem.words(wordCountMin=5)

Returns: cur suppellex a cognatus arca