aboutsummaryrefslogtreecommitdiff
path: root/src/faker.ts
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2024-02-05 09:39:09 +0100
committerGitHub <[email protected]>2024-02-05 08:39:09 +0000
commitacba5b7dd864ee51bc5dbc6861a2d5f3219ed5b2 (patch)
tree5d0cd07d093535a20a0781939848b2c92dba98c3 /src/faker.ts
parentacbdae73347aa9cafb253c7c51b677ca762da9c4 (diff)
downloadfaker-acba5b7dd864ee51bc5dbc6861a2d5f3219ed5b2.tar.xz
faker-acba5b7dd864ee51bc5dbc6861a2d5f3219ed5b2.zip
docs: missing options jsdocs (#2638)
Diffstat (limited to 'src/faker.ts')
-rw-r--r--src/faker.ts19
1 files changed, 19 insertions, 0 deletions
diff --git a/src/faker.ts b/src/faker.ts
index 97a513d0..e63b89b3 100644
--- a/src/faker.ts
+++ b/src/faker.ts
@@ -183,8 +183,27 @@ export class Faker extends SimpleFaker {
* @deprecated Use `new Faker({ locale: [locale, localeFallback] })` instead.
*/
constructor(options: {
+ /**
+ * The locale data to use for this instance.
+ *
+ * @deprecated Use `new Faker({ locale: [locale, localeFallback] })` instead.
+ */
locales: Record<string, LocaleDefinition>;
+ /**
+ * The name of the main locale to use.
+ *
+ * @default 'en'
+ *
+ * @deprecated Use `new Faker({ locale: [locale, localeFallback] })` instead.
+ */
locale?: string;
+ /**
+ * The name of the fallback locale to use.
+ *
+ * @default 'en'
+ *
+ * @deprecated Use `new Faker({ locale: [locale, localeFallback] })` instead.
+ */
localeFallback?: string;
});
// This is somehow required for `ConstructorParameters<typeof Faker>[0]` to work