diff options
| author | Matt Mayer <[email protected]> | 2023-03-29 20:36:46 +0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-03-29 13:36:46 +0000 |
| commit | 3562e872530b3610d95be71aa6f4f7fdfef7134f (patch) | |
| tree | c6ba28a9f3cf30e5bf5c0a935fead6bdb2668531 /src/modules/hacker | |
| parent | 88e561a5490003a41665eb007c5c28ff0800ae09 (diff) | |
| download | faker-3562e872530b3610d95be71aa6f4f7fdfef7134f.tar.xz faker-3562e872530b3610d95be71aa6f4f7fdfef7134f.zip | |
docs: add overview guides to specific modules (#1929)
Diffstat (limited to 'src/modules/hacker')
| -rw-r--r-- | src/modules/hacker/index.ts | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/src/modules/hacker/index.ts b/src/modules/hacker/index.ts index 00b9a686..ef0aa013 100644 --- a/src/modules/hacker/index.ts +++ b/src/modules/hacker/index.ts @@ -2,6 +2,18 @@ import type { Faker } from '../..'; /** * Module to generate hacker/IT words and phrases. + * + * ### Overview + * + * There are methods for different parts of speech, such as [`abbreviation()`](https://next.fakerjs.dev/api/hacker.html#abbreviation), [`adjective()`](https://next.fakerjs.dev/api/hacker.html#adjective), [`noun()`](https://next.fakerjs.dev/api/hacker.html#noun), [`verb()`](https://next.fakerjs.dev/api/hacker.html#verb), and [`ingverb()`](https://next.fakerjs.dev/api/hacker.html#ingverb). Alternatively, [`phrase()`](https://next.fakerjs.dev/api/hacker.html#phrase) creates a longer phrase combining these words. + * + * ### Related modules + * + * Various modules allow for generating other types of words and phrases: + * + * - [faker.word](https://next.fakerjs.dev/api/word.html) uses general vocabulary rather than hacker-specific terms. + * - [faker.lorem](https://next.fakerjs.dev/api/lorem.html) uses faux-Latin "lorem ipsum" text. + * - [faker.company](https://next.fakerjs.dev/api/company.html) includes corporate catchphrases and buzzwords. */ export class HackerModule { constructor(private readonly faker: Faker) { |
