aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2024-03-05 22:33:35 +0100
committerGitHub <[email protected]>2024-03-05 22:33:35 +0100
commitade91fd30d6b5fbcc2ab2534502467b1e0f3b086 (patch)
treeee823735e3141a452297aae4db6a208ce89241ea /src
parent489bbc243f3094464888bdf7fb90835fcfa57691 (diff)
downloadfaker-ade91fd30d6b5fbcc2ab2534502467b1e0f3b086.tar.xz
faker-ade91fd30d6b5fbcc2ab2534502467b1e0f3b086.zip
docs: improve jsdocs default texts (#2717)
Diffstat (limited to 'src')
-rw-r--r--src/modules/git/index.ts6
-rw-r--r--src/modules/image/index.ts30
-rw-r--r--src/modules/word/filter-word-list-by-length.ts2
3 files changed, 19 insertions, 19 deletions
diff --git a/src/modules/git/index.ts b/src/modules/git/index.ts
index 15cd21a3..0c50b614 100644
--- a/src/modules/git/index.ts
+++ b/src/modules/git/index.ts
@@ -29,8 +29,8 @@ export class GitModule extends ModuleBase {
* Generates a random commit entry as printed by `git log`.
*
* @param options Options for the commit entry.
- * @param options.merge Set to `true` to generate a merge message line.
- * @param options.eol Choose the end of line character to use. Defaults to 'CRLF'.
+ * @param options.merge Whether to generate a merge message line. Defaults to 20% `true` and 80% `false`.
+ * @param options.eol Choose the end of line character to use. Defaults to `'CRLF'`.
* 'LF' = '\n',
* 'CRLF' = '\r\n'
* @param options.refDate The date to use as reference point for the commit. Defaults to `new Date()`.
@@ -192,7 +192,7 @@ export class GitModule extends ModuleBase {
* - 8 for GitLab
*
* @param options Options for the commit sha.
- * @param options.length The length of the commit sha. Defaults to 40.
+ * @param options.length The length of the commit sha. Defaults to `40`.
*
* @example
* faker.git.commitSha() // '2c6e3880fd94ddb7ef72d34e683cdc0c47bec6e6'
diff --git a/src/modules/image/index.ts b/src/modules/image/index.ts
index d396d5fa..02b3c31c 100644
--- a/src/modules/image/index.ts
+++ b/src/modules/image/index.ts
@@ -67,8 +67,8 @@ export class ImageModule extends ModuleBase {
* Generates a random image url.
*
* @param options Options for generating a URL for an image.
- * @param options.width The width of the image. Defaults to random integer between `1` and `3999`.
- * @param options.height The height of the image. Defaults to random integer between `1` and `3999`.
+ * @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`.
*
* @example
* faker.image.url() // 'https://loremflickr.com/640/480?lock=1234'
@@ -109,8 +109,8 @@ export class ImageModule extends ModuleBase {
* Generates a random image url provided via https://loremflickr.com.
*
* @param options Options for generating a URL for an image.
- * @param options.width The width of the image. Defaults to random integer between `1` and `3999`.
- * @param options.height The height of the image. Defaults to random integer between `1` and `3999`.
+ * @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`.
* @param options.category Category to use for the image.
*
* @example
@@ -156,10 +156,10 @@ export class ImageModule extends ModuleBase {
* Generates a random image url provided via https://picsum.photos.
*
* @param options Options for generating a URL for an image.
- * @param options.width The width of the image. Defaults to random integer between `1` and `3999`.
- * @param options.height The height of the image. Defaults to random integer between `1` and `3999`.
+ * @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`.
* @param options.grayscale Whether the image should be grayscale. Defaults to a random boolean value.
- * @param options.blur Whether the image should be blurred. `0` disables the blur. Defaults to a random integer from `0` to `10`.
+ * @param options.blur Whether the image should be blurred. `0` disables the blur. Defaults to a random integer between `0` and `10`.
*
* @example
* faker.image.urlPicsumPhotos() // 'https://picsum.photos/seed/NWbJM2B/640/480'
@@ -235,12 +235,12 @@ export class ImageModule extends ModuleBase {
* Generates a random image url provided via https://via.placeholder.com/.
*
* @param options Options for generating a URL for an image.
- * @param options.width The width of the image. Defaults to random number between 1 and 3999.
- * @param options.height The height of the image. Defaults to random number between 1 and 3999.
- * @param options.backgroundColor The background color of the image. Defaults to random hex color.
- * @param options.textColor The text color of the image. Defaults to random hex color.
- * @param options.format The format of the image. Defaults to random format.
- * @param options.text The text to display on the image. Defaults to string.
+ * @param options.width The width of the image. Defaults to a random number between 1 and 3999.
+ * @param options.height The height of the image. Defaults to a random number between 1 and 3999.
+ * @param options.backgroundColor The background color of the image. Defaults to a random hex color.
+ * @param options.textColor The text color of the image. Defaults to a random hex color.
+ * @param options.format The format of the image. Defaults to a random format.
+ * @param options.text The text to display on the image. Defaults to a random string.
*
* @example
* faker.image.urlPlaceholder() // 'https://via.placeholder.com/150x180/FF0000/FFFFFF.webp?text=lorem'
@@ -328,8 +328,8 @@ export class ImageModule extends ModuleBase {
* Generates a random data uri containing an URL-encoded SVG image or a Base64-encoded SVG image.
*
* @param options Options for generating a data uri.
- * @param options.width The width of the image. Defaults to random integer between `1` and `3999`.
- * @param options.height The height of the image. Defaults to random integer between `1` and `3999`.
+ * @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`.
* @param options.color The color of the image. Must be a color supported by svg. Defaults to a random color.
* @param options.type The type of the image. Defaults to a random type.
*
diff --git a/src/modules/word/filter-word-list-by-length.ts b/src/modules/word/filter-word-list-by-length.ts
index f3fcd5ab..53522942 100644
--- a/src/modules/word/filter-word-list-by-length.ts
+++ b/src/modules/word/filter-word-list-by-length.ts
@@ -53,7 +53,7 @@ string, // Parameters<filterWordListByLength>[0]['strategy']
* @param options The options to provide.
* @param options.wordList A list of words to filter.
* @param options.length The exact or the range of lengths the words should have.
- * @param options.strategy The strategy to apply when no words with a matching length are found. Defaults to 'any-length'.
+ * @param options.strategy The strategy to apply when no words with a matching length are found. Defaults to `'any-length'`.
*
* Available error handling strategies:
*