Skip to content

Commit b26bdff

Browse files
docs(lorem): define allowed words
1 parent 6e6fa4c commit b26bdff

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

src/definitions/lorem.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ import type { LocaleEntry } from './definitions';
22

33
/**
44
* The possible definitions related to lorem texts.
5+
*
6+
* The words in this module are determined by the ISO 15924 script of the locale.
7+
* If a locale uses the Latin script, it will utilize Latin lorem words, while a locale using the Cyrillic script will use Cyrillic lorem words, and so forth.
58
*/
69
export type LoremDefinition = LocaleEntry<{
710
/**

src/modules/lorem/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ import { filterWordListByLength } from '../word/filter-word-list-by-length';
44
/**
55
* Module to generate random texts and words.
66
*
7+
* The words in this module are determined by the script of the locale used in the faker instance.
8+
* If a locale uses the Latin script, it will utilize Latin lorem words, while a locale using the Cyrillic script will use Cyrillic lorem words, and so forth.
9+
*
710
* ### Overview
811
*
912
* Generate dummy content using traditional faux-Latin [lorem ipsum](https://en.wikipedia.org/wiki/Lorem_ipsum) (in other locales to `en`, alternative words may be used).

0 commit comments

Comments
 (0)