This commit is contained in:
Pipi Chen
2020-05-07 01:02:44 +08:00
commit b8a3516cd6
2147 changed files with 184854 additions and 0 deletions

28
node_modules/chance/docs/text/paragraph.md generated vendored Normal file
View File

@@ -0,0 +1,28 @@
# paragraph
```js
// usage
chance.paragraph()
chance.paragraph({ sentences: 1 })
```
Return a random paragraph generated from sentences populated by semi-pronounceable
random (nonsense) words.
```js
chance.paragraph();
=> 'Lel fi huepe jupu akse zej ire vesik kojvulom zon is biwuwkef pa. Uv hokivej voh ebu numdogi akolo hik uwlez ta vacev ofdaimi acunetum suvet uhdab ir soglazo ju pafbeb. Pub cezeh fuc kebamnul he ok luumoabi rawkig me fov pin zup biv risugra. Ralpunad apkomgib alnirciw akel wa lus wahfum burog buol vecotihe abadahoj ugolo wovki ucojal fec.'
```
Default is a paragraph with a random number of sentences from 3 to 7.
Optionally specify the number of sentences in the paragraph.
```js
chance.paragraph({ sentences: 1 });
=> 'Idefeulo foc omoemowa wahteze liv juvde puguprof epehuji upuga zige odfe igo sit pilamhul oto ukurecef.'
```

28
node_modules/chance/docs/text/sentence.md generated vendored Normal file
View File

@@ -0,0 +1,28 @@
# sentence
```js
// usage
chance.sentence()
chance.sentence({ words: 5 })
```
Return a random sentence populated by semi-pronounceable random (nonsense) words.
```js
chance.sentence();
=> 'Witpevze mappos isoletu fo res bi geow pofin mu rupoho revzi utva ne.'
```
The sentence starts with a capital letter, and ends with a period.
Default is a sentence with a random number of words from 12 to 18.
*This length is chosen as the default as it works out to the average English
sentence is in that range.*
Optionally specify the number of words in the sentence.
```js
chance.sentence({ words: 5 });
=> 'Waddik jeasmov cakgilta ficub up.'
```

18
node_modules/chance/docs/text/syllable.md generated vendored Normal file
View File

@@ -0,0 +1,18 @@
# syllable
```js
// usage
chance.syllable()
```
Return a semi-speakable syllable, 2 or 3 letters
```js
chance.syllable();
=> 'fop'
```
The syllable is returned in all lower case.
A syllable generally alternates between vowel and consonant and is used as the
core building block for a word.

54
node_modules/chance/docs/text/word.md generated vendored Normal file
View File

@@ -0,0 +1,54 @@
# word
```js
// usage
chance.word()
chance.word({ syllables: 3 })
chance.word({ length: 5 })
```
Return a semi-pronounceable random (nonsense) word.
```js
chance.word();
=> 'bappada'
```
The word is returned in all lower case.
Default is a word with a random number of syllables from 1 to 3.
<p class="pullquote">This length is chosen as it works out to the average word length of ~5-6 chars
which seems about right.</p>
Can optionally specify a number of syllables which the word will have.
Note these are not syllables in the strict language definition of the word, but
syllables as we've defined here which is 2 or 3 characters, mostly alternating
between vowel and consanant. This is the about the best we can do with purely
random generation.
```js
chance.word({ syllables: 3 });
=> 'tavnamgi'
```
Can optionally specify a length and the word will obey that bounding.
```js
chance.word({ length: 5 });
=> 'ralve'
```
In this case these 2 options are mutually exclusive, that is they cannot be
combined as they often make no sense. It wouldn't be possible to have a word
with 7 syllables and a length of 5 or a length of 30 but 2 syllables.
Therefore, if both are specified, an Exception will be thrown so the Developer
can handle their broken case.
```js
chance.word({ length: 5, syllables: 20 });
=> new RangeError("Chance: Cannot specify both syllables AND length.");
```