aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorMatt Mayer <[email protected]>2023-01-24 16:04:32 +0700
committerGitHub <[email protected]>2023-01-24 09:04:32 +0000
commit28a9848a8efed508a677afa868cc0c31db777979 (patch)
treedd457b5c56ec29a935b5c2af44cc5710783be27a /src
parent0af40f7164ecc2a5ce7a2753f83484f75c4ae257 (diff)
downloadfaker-28a9848a8efed508a677afa868cc0c31db777979.tar.xz
faker-28a9848a8efed508a677afa868cc0c31db777979.zip
docs(internet): document emoji type values (#1732)
Diffstat (limited to 'src')
-rw-r--r--src/modules/internet/index.ts2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/modules/internet/index.ts b/src/modules/internet/index.ts
index d1af8ebe..f07ab973 100644
--- a/src/modules/internet/index.ts
+++ b/src/modules/internet/index.ts
@@ -608,7 +608,7 @@ export class InternetModule {
* Generates a random emoji.
*
* @param options Options object.
- * @param options.types A list of the emoji types that should be used.
+ * @param options.types A list of the emoji types that should be included. Possible values are `'smiley'`, `'body'`, `'person'`, `'nature'`, `'food'`, `'travel'`, `'activity'`, `'object'`, `'symbol'`, `'flag'`. By default, emojis from any type will be included.
*
* @example
* faker.internet.emoji() // '🥰'