diff options
| author | Eric Cheng <[email protected]> | 2023-05-25 19:02:58 -0400 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-05-25 23:02:58 +0000 |
| commit | 012ba2c80924b7bb1b241f170bae9dad25dacc2e (patch) | |
| tree | 7aa1e4675de4d9d597dc55b5f964e8dfb3c4fe3c /src/modules/image/providers/placeholder.ts | |
| parent | c173150a96a95818b0c4fd6cb2d41daea7e9ad0a (diff) | |
| download | faker-012ba2c80924b7bb1b241f170bae9dad25dacc2e.tar.xz faker-012ba2c80924b7bb1b241f170bae9dad25dacc2e.zip | |
docs(image): add content warnings to image function jsdocs (#2159)
Diffstat (limited to 'src/modules/image/providers/placeholder.ts')
| -rw-r--r-- | src/modules/image/providers/placeholder.ts | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/src/modules/image/providers/placeholder.ts b/src/modules/image/providers/placeholder.ts index 42108c56..c7514f23 100644 --- a/src/modules/image/providers/placeholder.ts +++ b/src/modules/image/providers/placeholder.ts @@ -5,6 +5,8 @@ import { deprecated } from '../../../internal/deprecated'; /** * Module to generate links to images on `https://via.placeholder.com/`. * + * The images generated from this module are fetched from an external service outside the control of Faker and could occasionally contain URLs which are broken or point to unexpected, disturbing, or offensive images. The service may also be subject to usage limits. + * * @deprecated Use `faker.image.urlPlaceholder` instead. */ export class Placeholder { @@ -24,6 +26,8 @@ export class Placeholder { /** * Generates a new placeholder image url. * + * These images are fetched from an external service outside the control of Faker and could occasionally contain URLs which point to unexpected, disturbing, or offensive images. Usage limits may contribute to this behavior. + * * @param width The width of the image (in pixels). Defaults to `640`. * @param height The height of the image (in pixels). Defaults to `width`. * @param text The text of the image. @@ -85,6 +89,8 @@ export class Placeholder { /** * Generate a new placeholder image with random colors and text. * + * These images are fetched from an external service outside the control of Faker and could occasionally contain URLs which point to unexpected, disturbing, or offensive images. Usage limits may contribute to this behavior. + * * @param width The width of the image (in pixels). Defaults to `640`. * @param height The height of the image (in pixels). Defaults to `width`. * @param format The file format of the image. Supports `png` `jpeg` `png` `gif` `webp`. |
