aboutsummaryrefslogtreecommitdiff
path: root/src/locale/fa.ts
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2024-10-21 14:48:28 +0200
committerGitHub <[email protected]>2024-10-21 12:48:28 +0000
commitf917f4fd348d2cce7883dc2b0d46c4dda72ec442 (patch)
tree657fc5e73ddbec4b259b9a54a815aa29d7fde44a /src/locale/fa.ts
parent18e59aa8805b3413b6f8058b1a00ff5bcbfbc935 (diff)
downloadfaker-f917f4fd348d2cce7883dc2b0d46c4dda72ec442.tar.xz
faker-f917f4fd348d2cce7883dc2b0d46c4dda72ec442.zip
docs: add jsdocs to the pre-built instances (#3193)
Diffstat (limited to 'src/locale/fa.ts')
-rw-r--r--src/locale/fa.ts12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/locale/fa.ts b/src/locale/fa.ts
index 9d332527..5efb1da5 100644
--- a/src/locale/fa.ts
+++ b/src/locale/fa.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
import en from '../locales/en';
import fa from '../locales/fa';
+/**
+ * The faker instance for the `fa` locale.
+ *
+ * - Language: Farsi/Persian
+ * - Endonym: فارسی
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `fa`
+ * - `en`
+ * - `base`
+ */
export const faker = new Faker({
locale: [fa, en, base],
});