aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2022-03-01 19:55:53 +0100
committerGitHub <[email protected]>2022-03-01 19:55:53 +0100
commit61fafe47547873fcde74e98bff2a70738df7d4f2 (patch)
tree379432fee1ba309ba1a004bd37af04bba4628a79 /src
parent442812f66a5ad9a42e389ad1ae06dbbcddad4e99 (diff)
downloadfaker-61fafe47547873fcde74e98bff2a70738df7d4f2.tar.xz
faker-61fafe47547873fcde74e98bff2a70738df7d4f2.zip
docs: generate docs for fake() and unique() (#564)
Diffstat (limited to 'src')
-rw-r--r--src/fake.ts4
-rw-r--r--src/unique.ts1
2 files changed, 4 insertions, 1 deletions
diff --git a/src/fake.ts b/src/fake.ts
index a20aae11..d56b4794 100644
--- a/src/fake.ts
+++ b/src/fake.ts
@@ -30,7 +30,9 @@ export class Fake {
*
* Please note that is NOT possible to use any non-faker methods or plain js script in there.
*
- * @param str The format string that will get interpolated.
+ * @param str The format string that will get interpolated. May not be empty.
+ *
+ * @see faker.helpers.mustache() to use custom functions for resolution.
*
* @example
* faker.fake('{{name.lastName}}') // 'Barrows'
diff --git a/src/unique.ts b/src/unique.ts
index acb6931f..6ef5eee5 100644
--- a/src/unique.ts
+++ b/src/unique.ts
@@ -28,6 +28,7 @@ export class Unique {
* Generates a unique result using the results of the given method.
* Used unique entries will be stored internally and filtered from subsequent calls.
*
+ * @template Method The type of the method to execute.
* @param method The method used to generate the values.
* @param args The arguments used to call the method.
* @param opts The optional options used to configure this method.