docs(image): add content warnings to image function jsdocs

src/modules/image/providers/lorempicsum.ts

@@ -5,6 +5,8 @@ import { deprecated } from '../../../internal/deprecated';
 /**
  * Module to generate links to random images on https://picsum.photos.
  *
+ * 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.urlPicsumPhotos` instead.
  */
 export class LoremPicsum {
@@ -13,6 +15,8 @@ export class LoremPicsum {
   /**
    * Generates a new picsum photos 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. Defaults to `640`.
    * @param height The height of the image. Defaults to `480`.
    * @param grayscale Whether to return a grayscale image. Default to `false`.
@@ -38,6 +42,8 @@ export class LoremPicsum {
   /**
    * Generates a new picsum photos 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. Defaults to `640`.
    * @param height The height of the image. Defaults to `480`.
    * @param grayscale Whether to return a grayscale image. Default to `false`.
@@ -57,6 +63,8 @@ export class LoremPicsum {
   /**
    * Generates a new picsum photos 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. Defaults to `640`.
    * @param height The height of the image. Defaults to `480`.
    * @param blur The optional level of blur to apply. Supports `1` - `10`.
@@ -80,6 +88,8 @@ export class LoremPicsum {
   /**
    * Generates a new picsum photos 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. Defaults to `640`.
    * @param height The height of the image. Defaults to `480`.
    * @param grayscale Whether to return a grayscale image. Default to `false`.
@@ -108,6 +118,8 @@ export class LoremPicsum {
   /**
    * Generates a new picsum photos 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. Defaults to `640`.
    * @param height The height of the image. Defaults to `480`.
    * @param grayscale Whether to return a grayscale image. Default to `false`.

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`.

src/modules/image/providers/unsplash.ts

@@ -5,6 +5,8 @@ import { deprecated } from '../../../internal/deprecated';
 /**
  * Module to generate links to random images on `https://source.unsplash.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` instead.
  */
 export class Unsplash {
@@ -13,6 +15,8 @@ export class Unsplash {
   /**
    * Generates a new unsplash image url for a random supported category.
    *
+   * 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. Defaults to `640`.
    * @param height The height of the image. Defaults to `480`.
    * @param keyword The image keywords to use.
@@ -32,6 +36,8 @@ export class Unsplash {
   /**
    * Generates a new unsplash 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. Defaults to `640`.
    * @param height The height of the image. Defaults to `480`.
    * @param category The category of the image to generate.
@@ -75,6 +81,8 @@ export class Unsplash {
   /**
    * Generates a new unsplash image url using the "food" category.
    *
+   * 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. Defaults to `640`.
    * @param height The height of the image. Defaults to `480`.
    * @param keyword The image keywords to use.
@@ -94,6 +102,8 @@ export class Unsplash {
   /**
    * Generates a new unsplash image url using the "people" category.
    *
+   * 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. Defaults to `640`.
    * @param height The height of the image. Defaults to `480`.
    * @param keyword The image keywords to use.
@@ -113,6 +123,8 @@ export class Unsplash {
   /**
    * Generates a new unsplash image url using the "nature" category.
    *
+   * 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. Defaults to `640`.
    * @param height The height of the image. Defaults to `480`.
    * @param keyword The image keywords to use.
@@ -132,6 +144,8 @@ export class Unsplash {
   /**
    * Generates a new unsplash image url using the "technology" category.
    *
+   * 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. Defaults to `640`.
    * @param height The height of the image. Defaults to `480`.
    * @param keyword The image keywords to use.
@@ -156,6 +170,8 @@ export class Unsplash {
   /**
    * Generates a new unsplash image url using the "objects" category.
    *
+   * 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. Defaults to `640`.
    * @param height The height of the image. Defaults to `480`.
    * @param keyword The image keywords to use.
@@ -180,6 +196,8 @@ export class Unsplash {
   /**
    * Generates a new unsplash image url using the "buildings" category.
    *
+   * 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. Defaults to `640`.
    * @param height The height of the image. Defaults to `480`.
    * @param keyword The image keywords to use.