aboutsummaryrefslogtreecommitdiff
path: root/src/modules
diff options
context:
space:
mode:
authorMatt Mayer <[email protected]>2024-10-13 19:14:24 +0700
committerGitHub <[email protected]>2024-10-13 14:14:24 +0200
commit60c48653eee8cddb1599ac98a893025127421084 (patch)
tree8f69cb64812e5c40656f9d87f652ac82ddf45895 /src/modules
parent34cf3643bee275f23bc7a39376c1b3d542a8c45f (diff)
downloadfaker-60c48653eee8cddb1599ac98a893025127421084.tar.xz
faker-60c48653eee8cddb1599ac98a893025127421084.zip
docs(image): update overview for image module (#3177)
Diffstat (limited to 'src/modules')
-rw-r--r--src/modules/image/index.ts2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/modules/image/index.ts b/src/modules/image/index.ts
index 76aa759e..67d0e2d8 100644
--- a/src/modules/image/index.ts
+++ b/src/modules/image/index.ts
@@ -13,7 +13,7 @@ import { ModuleBase } from '../../internal/module-base';
*
* For a random user avatar image, use [`avatar()`](https://fakerjs.dev/api/image.html#avatar).
*
- * This module previously also contained methods for specifically themed images like "fashion" or "food", but these are now deprecated. If you need more control over image type, you can request categorized images using [`urlLoremFlickr()`](https://fakerjs.dev/api/image.html#urlloremflickr), use an image provider directly or provide your own set of placeholder images.
+ * If you need more control over the content of the images, you can pass a `category` parameter e.g. `'cat'` or `'nature'` to [`urlLoremFlickr()`](https://fakerjs.dev/api/image.html#urlloremflickr) or simply use [`faker.helpers.arrayElement()`](https://fakerjs.dev/api/helpers.html#arrayelement) with your own array of image URLs.
*/
export class ImageModule extends ModuleBase {
/**