6.10.129 • Published 11 months ago

@patrtorg/aspernatur-dolorum-ducimus v6.10.129

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

@patrtorg/aspernatur-dolorum-ducimus

Lightweight util for generating random sentences, paragraphs and articles in English. Inspired by Sentencer and metaphorpsum.com.

NPM CI test Coverage Status CodeQL

Demo

Setup

Usage

Node.js:

import {
  sentence
} from '@patrtorg/aspernatur-dolorum-ducimus'

// with CommonJS environment
// const { sentence } = require('@patrtorg/aspernatur-dolorum-ducimus/dist/cjs/@patrtorg/aspernatur-dolorum-ducimus.js')

sentence()

Browsers:

Currently, ECMAScript modules work fine on almost all browsers:

<script type="module">
import { sentence } from 'https://unpkg.com/@patrtorg/aspernatur-dolorum-ducimus/dist/@patrtorg/aspernatur-dolorum-ducimus.esm.js'
console.log(sentence())
</script>

With outdated browsers, we can use the traditional method:

<script type="text/javascript" src="https://unpkg.com/@patrtorg/aspernatur-dolorum-ducimus/dist/@patrtorg/aspernatur-dolorum-ducimus.min.js"></script>

<script>
console.log(window.@patrtorg/aspernatur-dolorum-ducimus.sentence())
</script>

APIs

  • .sentence()
  • .paragraph([Number totalSentences])
  • .article([Number totalParagraphs])
  • .addNouns(Array nouns)
  • .addAdjectives(Array adjectives)
  • .addTemplates(Array sentenceTemplates)
  • .setNouns(Array nouns)
  • .setAdjectives(Array adjectives)
  • .setTemplates(Array sentenceTemplates)
  • .getNouns()
  • .getAdjectives()
  • .getTemplates()
  • .lorem([Number min [, Number max]])

As their name suggests, we have 4 groups of methods:

  • sentence(), paragraph(), article(): generate text by given grammatical unit
  • addNouns(), addAdjectives(), addTemplates(): add more samples to current sample set
  • setNouns(), setAdjectives(), setTemplates(): replace current sample set with new ones
  • getNouns(), getAdjectives(), getTemplates(): get current sample set

The set* and get* methods were added in v2.2.3 to help you customize your sample data.

In addition, we've added lorem() method since v3.0.5 to generate lorem ipsum text.

Template

If you want to add more kinds of sentences, just use the .addTemplates() method; it expects a list of sentence templates. Each sentence template is an English sentence, containing placeholders that can be replaced with any alternative word.

For example:

import {
  addTemplates
} from '@patrtorg/aspernatur-dolorum-ducimus'

const templates = [
  '{{a_noun}} is {{a_noun}} from the right perspective',
  'the {{noun}} of {{a_noun}} becomes {{an_adjective}} {{noun}}'
]

addTemplates(templates)

Here are the available placeholders:

  • noun
  • nouns
  • a_noun
  • adjective
  • an_adjective

Lorem ipsum

Syntax:

lorem() // generate a random phrase with length from 2 to 24 words of lorem ipsum
lorem(Number min) // set the minimum number of words
lorem(Number min, Number max)// set the minimum/maximum number of words

Example:

import { lorem } from '@patrtorg/aspernatur-dolorum-ducimus'

const phrase = lorem()
console.log(phrase) // => nisi blandit feugiat tempus imperdiet etiam eu mus augue

Test

git clone https://github.com/patrtorg/aspernatur-dolorum-ducimus.git
cd @patrtorg/aspernatur-dolorum-ducimus
npm install
npm test

License

The MIT License (MIT)

@patrtorg/numquam-doloribus-sit@patrtorg/doloribus-aperiam@patrtorg/dolorum-blanditiis@patrtorg/dolorum-quisquam-molestias@patrtorg/eaque-tempore-temporibus@patrtorg/ducimus-hic@patrtorg/eaque-dolorem-iusto@patrtorg/enim-culpa@patrtorg/enim-quas@patrtorg/est-corrupti@patrtorg/error-expedita-rerum@patrtorg/esse-ut@patrtorg/esse-occaecati-quos@patrtorg/ex-iure@patrtorg/expedita-deleniti-ratione@patrtorg/expedita-eaque-at@patrtorg/fugiat-beatae-quas@patrtorg/fugiat-perspiciatis@patrtorg/fugit-cumque@patrtorg/illo-saepe@patrtorg/hic-facere-ratione@patrtorg/itaque-beatae@patrtorg/iste-sunt@patrtorg/iure-at@patrtorg/labore-nemo-impedit@patrtorg/molestiae-nulla-architecto@patrtorg/modi-aut-dolorem@patrtorg/modi-officia-iusto@patrtorg/nihil-at@patrtorg/nihil-vero-ipsa@patrtorg/pariatur-sapiente@patrtorg/quia-laborum-porro@patrtorg/qui-dolore@patrtorg/quidem-dolore@patrtorg/qui-omnis-voluptates@patrtorg/similique-nam@patrtorg/sed-laudantium-nemo@patrtorg/sapiente-sed-eius@patrtorg/sed-veritatis-placeat@patrtorg/soluta-quo@patrtorg/nisi-perferendis@patrtorg/perspiciatis-possimus@patrtorg/quo-cupiditate-sit@patrtorg/saepe-tenetur-iusto@patrtorg/repellendus-ex@patrtorg/repudiandae-dolore@patrtorg/repellat-quam@patrtorg/tempora-quas@patrtorg/tempore-cumque@patrtorg/vero-quibusdam-ipsa@patrtorg/maiores-adipisci-maxime@patrtorg/nostrum-beatae-a@patrtorg/nobis-assumenda-optio@patrtorg/nobis-nobis@patrtorg/quas-sed-id@patrtorg/reiciendis-doloribus-officia@patrtorg/soluta-numquam@patrtorg/soluta-et@patrtorg/neque-consectetur@patrtorg/neque-voluptatem@patrtorg/odit-facere@patrtorg/officiis-qui@patrtorg/odio-ratione@patrtorg/officiis-dolorum@patrtorg/quos-hic@patrtorg/similique-vero-sapiente@patrtorg/sit-ipsam-dolore@patrtorg/suscipit-sit-culpa@patrtorg/tempora-impedit-dolore@patrtorg/porro-voluptates@patrtorg/quod-asperiores@patrtorg/tenetur-aut@patrtorg/tempore-labore-mollitia@patrtorg/totam-accusamus@patrtorg/veritatis-vel-amet@patrtorg/veritatis-ad-voluptates@patrtorg/occaecati-reiciendis-reiciendis@patrtorg/pariatur-repellendus-aspernatur@patrtorg/quo-in@patrtorg/sunt-distinctio-illo@patrtorg/sunt-asperiores@patrtorg/ullam-eum@patrtorg/ullam-doloremque@patrtorg/unde-cupiditate@patrtorg/animi-laboriosam-adipisci@patrtorg/aperiam-quaerat@patrtorg/aspernatur-assumenda@patrtorg/architecto-laudantium@patrtorg/aspernatur-repellendus-assumenda@patrtorg/assumenda-officia@patrtorg/assumenda-qui@patrtorg/assumenda-ipsam@patrtorg/aspernatur-laborum@patrtorg/at-sunt-itaque@patrtorg/commodi-illo@patrtorg/beatae-quas@patrtorg/blanditiis-ea-quaerat@patrtorg/blanditiis-quibusdam-sit@patrtorg/consectetur-odio-placeat@patrtorg/consequatur-distinctio
6.10.127

11 months ago

6.10.128

11 months ago

6.10.129

11 months ago

6.8.104

1 year ago

6.10.119

12 months ago

6.8.109

12 months ago

6.10.117

12 months ago

6.10.118

12 months ago

6.8.106

1 year ago

6.8.105

1 year ago

6.8.108

1 year ago

6.8.107

1 year ago

6.10.122

12 months ago

6.10.123

12 months ago

6.10.120

12 months ago

6.10.121

12 months ago

6.10.126

12 months ago

6.10.124

12 months ago

6.10.125

12 months ago

6.8.112

12 months ago

6.8.111

12 months ago

6.8.110

12 months ago

6.9.114

12 months ago

6.9.113

12 months ago

6.9.112

12 months ago

6.10.115

12 months ago

6.10.116

12 months ago

6.10.114

12 months ago

5.8.102

1 year ago

5.8.103

1 year ago

5.8.104

1 year ago

5.7.102

1 year ago

5.6.97

1 year ago

3.5.96

1 year ago

3.5.95

1 year ago

1.4.20

1 year ago

1.4.22

1 year ago

1.4.21

1 year ago

3.5.94

1 year ago

1.4.24

1 year ago

3.5.93

1 year ago

1.4.23

1 year ago

3.5.92

1 year ago

1.4.26

1 year ago

3.5.91

1 year ago

1.4.25

1 year ago

3.5.90

1 year ago

1.4.28

1 year ago

5.6.98

1 year ago

1.4.27

1 year ago

1.4.29

1 year ago

2.5.58

1 year ago

1.4.31

1 year ago

2.5.59

1 year ago

1.4.30

1 year ago

1.4.33

1 year ago

1.4.32

1 year ago

2.5.54

1 year ago

1.4.35

1 year ago

2.5.55

1 year ago

1.4.34

1 year ago

2.5.56

1 year ago

2.5.57

1 year ago

1.4.36

1 year ago

2.5.50

1 year ago

2.5.51

1 year ago

2.5.52

1 year ago

1.2.14

1 year ago

2.5.53

1 year ago

2.5.60

1 year ago

1.5.50

1 year ago

2.5.69

1 year ago

2.5.65

1 year ago

2.5.66

1 year ago

2.5.67

1 year ago

2.5.68

1 year ago

2.5.61

1 year ago

2.5.62

1 year ago

2.5.63

1 year ago

2.5.64

1 year ago

3.5.89

1 year ago

2.5.70

1 year ago

3.5.88

1 year ago

2.5.71

1 year ago

3.5.87

1 year ago

5.7.101

1 year ago

2.5.76

1 year ago

2.5.77

1 year ago

2.5.78

1 year ago

5.7.100

1 year ago

2.5.79

1 year ago

2.5.72

1 year ago

1.4.17

1 year ago

2.5.73

1 year ago

1.4.16

1 year ago

2.5.74

1 year ago

1.4.19

1 year ago

2.5.75

1 year ago

1.4.18

1 year ago

2.5.80

1 year ago

2.5.81

1 year ago

2.5.82

1 year ago

2.5.87

1 year ago

1.5.36

1 year ago

1.3.14

1 year ago

1.5.38

1 year ago

1.5.37

1 year ago

2.5.83

1 year ago

2.5.84

1 year ago

1.5.39

1 year ago

2.5.85

1 year ago

1.3.15

1 year ago

2.5.86

1 year ago

1.3.16

1 year ago

5.7.98

1 year ago

1.5.41

1 year ago

1.5.40

1 year ago

1.5.43

1 year ago

1.5.42

1 year ago

1.5.45

1 year ago

1.5.44

1 year ago

1.5.47

1 year ago

1.5.46

1 year ago

1.5.49

1 year ago

1.5.48

1 year ago

5.7.99

1 year ago

3.6.97

1 year ago

3.6.96

1 year ago

4.6.97

1 year ago

1.2.13

1 year ago

1.1.12

1 year ago

1.0.11

1 year ago

1.1.11

1 year ago

1.1.13

1 year ago

1.0.10

1 year ago

1.0.9

1 year ago

1.0.8

1 year ago

1.0.7

1 year ago

1.0.6

1 year ago

1.0.5

1 year ago

1.0.4

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago