Skip to content

Commit

Permalink
refactor(image)!: fix JSDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
Shinigami92 committed Nov 4, 2022
1 parent f0b35b0 commit 9eae691
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/modules/image/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,9 @@ export class ImageModule {
* @param options.provider The image provider to use. Defaults to `'loremflickr'`.
* @param options.width The width of the image. Defaults to `640`.
* @param options.height The height of the image. Defaults to `480`.
* @param options.category The category of the image. Only applies to `provider = loremflickr`. Defaults to `undefined`.
* @param options.category The category of the image. Only applies to `provider = loremflickr`.
* @param options.grayscale Whether the image should be grayscale. Only applies to `provider = picsum`. Defaults to `false`.
* @param options.blur The blur of the image. Only applies to `provider = picsum`.
*
* @example
* faker.image.url() // 'https://loremflickr.com/640/480'
Expand Down

0 comments on commit 9eae691

Please sign in to comment.