diff options
Diffstat (limited to 'src/modules/image/index.ts')
| -rw-r--r-- | src/modules/image/index.ts | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/src/modules/image/index.ts b/src/modules/image/index.ts index 6b0a7017..ae4d76fe 100644 --- a/src/modules/image/index.ts +++ b/src/modules/image/index.ts @@ -20,6 +20,8 @@ export class ImageModule extends ModuleBase { /** * Generates a random avatar image url. * + * @remark This method sometimes generates a random string representing an URL from GitHub by using a random user ID. Faker is not responsible for the content of the image or the service providing it. + * * @example * faker.image.avatar() * // 'https://avatars.githubusercontent.com/u/97165289' @@ -38,6 +40,8 @@ export class ImageModule extends ModuleBase { /** * Generates a random avatar from GitHub. * + * @remark This method generates a random string representing an URL from GitHub by using a random user ID. Faker is not responsible for the content of the image or the service providing it. + * * @example * faker.image.avatarGitHub() * // 'https://avatars.githubusercontent.com/u/97165289' @@ -92,6 +96,8 @@ export class ImageModule extends ModuleBase { /** * Generates a random avatar from `https://cloudflare-ipfs.com/ipfs/Qmd3W5DuhgHirLHGVixi6V76LhCkZUz6pnFt5AJBiyvHye/avatar`. * + * @remark This method generates a random string representing an URL from cloudflare-ipfs. Faker is not responsible for the content of the image or the service providing it. + * * @example * faker.image.avatarLegacy() * // 'https://cloudflare-ipfs.com/ipfs/Qmd3W5DuhgHirLHGVixi6V76LhCkZUz6pnFt5AJBiyvHye/avatar/170.jpg' @@ -116,6 +122,8 @@ export class ImageModule extends ModuleBase { /** * Generates a random image url. * + * @remark This method generates a random string representing an URL from loremflickr. Faker is not responsible for the content of the image or the service providing it. + * * @param options Options for generating a URL for an image. * @param options.width The width of the image. Defaults to a random integer between `1` and `3999`. * @param options.height The height of the image. Defaults to a random integer between `1` and `3999`. @@ -158,6 +166,8 @@ export class ImageModule extends ModuleBase { /** * Generates a random image url provided via https://loremflickr.com. * + * @remark This method generates a random string representing an URL from loremflickr. Faker is not responsible for the content of the image or the service providing it. + * * @param options Options for generating a URL for an image. * @param options.width The width of the image. Defaults to a random integer between `1` and `3999`. * @param options.height The height of the image. Defaults to a random integer between `1` and `3999`. @@ -205,6 +215,8 @@ export class ImageModule extends ModuleBase { /** * Generates a random image url provided via https://picsum.photos. * + * @remark This method generates a random string representing an URL from picsum.photos. Faker is not responsible for the content of the image or the service providing it. + * * @param options Options for generating a URL for an image. * @param options.width The width of the image. Defaults to a random integer between `1` and `3999`. * @param options.height The height of the image. Defaults to a random integer between `1` and `3999`. @@ -284,6 +296,8 @@ export class ImageModule extends ModuleBase { /** * Generates a random image url provided via https://via.placeholder.com/. * + * @remark This method generates a random string representing an URL from via.placeholder. Faker is not responsible for the content of the image or the service providing it. + * * @param options Options for generating a URL for an image. * @param options.width The width of the image. Defaults to a random number between 1 and 3500. * @param options.height The height of the image. Defaults to a random number between 1 and 3500. |
