docs: add jsdocs to the pre-built instances (#3193)

69 files changed, 831 insertions, 0 deletions

diff --git a/src/locale/af_ZA.ts b/src/locale/af_ZA.ts
index 61dc3819..4169c76a 100644
--- a/src/locale/af_ZA.ts
+++ b/src/locale/af_ZA.ts
@@ -8,6 +8,18 @@ import af_ZA from '../locales/af_ZA';
 import base from '../locales/base';
 import en from '../locales/en';
 
+/**
+ * The faker instance for the `af_ZA` locale.
+ *
+ * - Language: Afrikaans (South Africa)
+ * - Endonym: Afrikaans (Suid-Afrika)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `af_ZA`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [af_ZA, en, base],
 });
diff --git a/src/locale/ar.ts b/src/locale/ar.ts
index 343d2e19..3edf2b36 100644
--- a/src/locale/ar.ts
+++ b/src/locale/ar.ts
@@ -8,6 +8,18 @@ import ar from '../locales/ar';
 import base from '../locales/base';
 import en from '../locales/en';
 
+/**
+ * The faker instance for the `ar` locale.
+ *
+ * - Language: Arabic
+ * - Endonym: اَلْعَرَبِيَّةُ
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `ar`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [ar, en, base],
 });
diff --git a/src/locale/az.ts b/src/locale/az.ts
index 6366b828..58a78b90 100644
--- a/src/locale/az.ts
+++ b/src/locale/az.ts
@@ -8,6 +8,18 @@ import az from '../locales/az';
 import base from '../locales/base';
 import en from '../locales/en';
 
+/**
+ * The faker instance for the `az` locale.
+ *
+ * - Language: Azerbaijani
+ * - Endonym: azərbaycan dili
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `az`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [az, en, base],
 });
diff --git a/src/locale/base.ts b/src/locale/base.ts
index 67db0218..00224714 100644
--- a/src/locale/base.ts
+++ b/src/locale/base.ts
@@ -6,6 +6,11 @@
 import { Faker } from '../faker';
 import base from '../locales/base';
 
+/**
+ * The faker instance for the `base` locale.
+ *
+ * The base locale contains data that is shared across all locales such as ISO codes, time zones, and more.
+ */
 export const faker = new Faker({
   locale: base,
 });
diff --git a/src/locale/cs_CZ.ts b/src/locale/cs_CZ.ts
index 4e56c6d4..c651f5cc 100644
--- a/src/locale/cs_CZ.ts
+++ b/src/locale/cs_CZ.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import cs_CZ from '../locales/cs_CZ';
 import en from '../locales/en';
 
+/**
+ * The faker instance for the `cs_CZ` locale.
+ *
+ * - Language: Czech (Czechia)
+ * - Endonym: čeština (Česká republika)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `cs_CZ`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [cs_CZ, en, base],
 });
diff --git a/src/locale/da.ts b/src/locale/da.ts
index c5be8919..854c6702 100644
--- a/src/locale/da.ts
+++ b/src/locale/da.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import da from '../locales/da';
 import en from '../locales/en';
 
+/**
+ * The faker instance for the `da` locale.
+ *
+ * - Language: Danish
+ * - Endonym: Dansk
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `da`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [da, en, base],
 });
diff --git a/src/locale/de.ts b/src/locale/de.ts
index 67801f85..5d98e1b9 100644
--- a/src/locale/de.ts
+++ b/src/locale/de.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import de from '../locales/de';
 import en from '../locales/en';
 
+/**
+ * The faker instance for the `de` locale.
+ *
+ * - Language: German
+ * - Endonym: Deutsch
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `de`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [de, en, base],
 });
diff --git a/src/locale/de_AT.ts b/src/locale/de_AT.ts
index a964ee7e..e86cfef3 100644
--- a/src/locale/de_AT.ts
+++ b/src/locale/de_AT.ts
@@ -9,6 +9,19 @@ import de from '../locales/de';
 import de_AT from '../locales/de_AT';
 import en from '../locales/en';
 
+/**
+ * The faker instance for the `de_AT` locale.
+ *
+ * - Language: German (Austria)
+ * - Endonym: Deutsch (Österreich)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `de_AT`
+ * - `de`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [de_AT, de, en, base],
 });
diff --git a/src/locale/de_CH.ts b/src/locale/de_CH.ts
index b3d0937a..ec789feb 100644
--- a/src/locale/de_CH.ts
+++ b/src/locale/de_CH.ts
@@ -9,6 +9,19 @@ import de from '../locales/de';
 import de_CH from '../locales/de_CH';
 import en from '../locales/en';
 
+/**
+ * The faker instance for the `de_CH` locale.
+ *
+ * - Language: German (Switzerland)
+ * - Endonym: Deutsch (Schweiz)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `de_CH`
+ * - `de`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [de_CH, de, en, base],
 });
diff --git a/src/locale/dv.ts b/src/locale/dv.ts
index dcf8bf4d..d9ca8952 100644
--- a/src/locale/dv.ts
+++ b/src/locale/dv.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import dv from '../locales/dv';
 import en from '../locales/en';
 
+/**
+ * The faker instance for the `dv` locale.
+ *
+ * - Language: Maldivian
+ * - Endonym: ދިވެހި
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `dv`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [dv, en, base],
 });
diff --git a/src/locale/el.ts b/src/locale/el.ts
index c6875989..383c7d5d 100644
--- a/src/locale/el.ts
+++ b/src/locale/el.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import el from '../locales/el';
 import en from '../locales/en';
 
+/**
+ * The faker instance for the `el` locale.
+ *
+ * - Language: Greek
+ * - Endonym: Ελληνικά
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `el`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [el, en, base],
 });
diff --git a/src/locale/en.ts b/src/locale/en.ts
index fc5abe42..8d4dafb4 100644
--- a/src/locale/en.ts
+++ b/src/locale/en.ts
@@ -7,6 +7,17 @@ import { Faker } from '../faker';
 import base from '../locales/base';
 import en from '../locales/en';
 
+/**
+ * The faker instance for the `en` locale.
+ *
+ * - Language: English
+ * - Endonym: English
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [en, base],
 });
diff --git a/src/locale/en_AU.ts b/src/locale/en_AU.ts
index 10c90dbe..e802c4b0 100644
--- a/src/locale/en_AU.ts
+++ b/src/locale/en_AU.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import en_AU from '../locales/en_AU';
 
+/**
+ * The faker instance for the `en_AU` locale.
+ *
+ * - Language: English (Australia)
+ * - Endonym: English (Australia)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `en_AU`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [en_AU, en, base],
 });
diff --git a/src/locale/en_AU_ocker.ts b/src/locale/en_AU_ocker.ts
index 1b302654..337305c3 100644
--- a/src/locale/en_AU_ocker.ts
+++ b/src/locale/en_AU_ocker.ts
@@ -9,6 +9,19 @@ import en from '../locales/en';
 import en_AU from '../locales/en_AU';
 import en_AU_ocker from '../locales/en_AU_ocker';
 
+/**
+ * The faker instance for the `en_AU_ocker` locale.
+ *
+ * - Language: English (Australia Ocker)
+ * - Endonym: English (Australia)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `en_AU_ocker`
+ * - `en_AU`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [en_AU_ocker, en_AU, en, base],
 });
diff --git a/src/locale/en_BORK.ts b/src/locale/en_BORK.ts
index 5f357c68..334ff285 100644
--- a/src/locale/en_BORK.ts
+++ b/src/locale/en_BORK.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import en_BORK from '../locales/en_BORK';
 
+/**
+ * The faker instance for the `en_BORK` locale.
+ *
+ * - Language: English (Bork)
+ * - Endonym: English (Bork)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `en_BORK`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [en_BORK, en, base],
 });
diff --git a/src/locale/en_CA.ts b/src/locale/en_CA.ts
index 40c86fce..8478315a 100644
--- a/src/locale/en_CA.ts
+++ b/src/locale/en_CA.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import en_CA from '../locales/en_CA';
 
+/**
+ * The faker instance for the `en_CA` locale.
+ *
+ * - Language: English (Canada)
+ * - Endonym: English (Canada)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `en_CA`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [en_CA, en, base],
 });
diff --git a/src/locale/en_GB.ts b/src/locale/en_GB.ts
index 4551d568..cbe9db5d 100644
--- a/src/locale/en_GB.ts
+++ b/src/locale/en_GB.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import en_GB from '../locales/en_GB';
 
+/**
+ * The faker instance for the `en_GB` locale.
+ *
+ * - Language: English (Great Britain)
+ * - Endonym: English (Great Britain)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `en_GB`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [en_GB, en, base],
 });
diff --git a/src/locale/en_GH.ts b/src/locale/en_GH.ts
index 8c81794f..2886d41f 100644
--- a/src/locale/en_GH.ts
+++ b/src/locale/en_GH.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import en_GH from '../locales/en_GH';
 
+/**
+ * The faker instance for the `en_GH` locale.
+ *
+ * - Language: English (Ghana)
+ * - Endonym: English (Ghana)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `en_GH`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [en_GH, en, base],
 });
diff --git a/src/locale/en_HK.ts b/src/locale/en_HK.ts
index a1d94947..19206a76 100644
--- a/src/locale/en_HK.ts
+++ b/src/locale/en_HK.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import en_HK from '../locales/en_HK';
 
+/**
+ * The faker instance for the `en_HK` locale.
+ *
+ * - Language: English (Hong Kong)
+ * - Endonym: English (Hong Kong)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `en_HK`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [en_HK, en, base],
 });
diff --git a/src/locale/en_IE.ts b/src/locale/en_IE.ts
index 96ed78a9..53815627 100644
--- a/src/locale/en_IE.ts
+++ b/src/locale/en_IE.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import en_IE from '../locales/en_IE';
 
+/**
+ * The faker instance for the `en_IE` locale.
+ *
+ * - Language: English (Ireland)
+ * - Endonym: English (Ireland)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `en_IE`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [en_IE, en, base],
 });
diff --git a/src/locale/en_IN.ts b/src/locale/en_IN.ts
index 75112107..001769e9 100644
--- a/src/locale/en_IN.ts
+++ b/src/locale/en_IN.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import en_IN from '../locales/en_IN';
 
+/**
+ * The faker instance for the `en_IN` locale.
+ *
+ * - Language: English (India)
+ * - Endonym: English (India)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `en_IN`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [en_IN, en, base],
 });
diff --git a/src/locale/en_NG.ts b/src/locale/en_NG.ts
index 6e9a5dc0..ff7490d0 100644
--- a/src/locale/en_NG.ts
+++ b/src/locale/en_NG.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import en_NG from '../locales/en_NG';
 
+/**
+ * The faker instance for the `en_NG` locale.
+ *
+ * - Language: English (Nigeria)
+ * - Endonym: English (Nigeria)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `en_NG`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [en_NG, en, base],
 });
diff --git a/src/locale/en_US.ts b/src/locale/en_US.ts
index d54d8e49..6f87cb3a 100644
--- a/src/locale/en_US.ts
+++ b/src/locale/en_US.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import en_US from '../locales/en_US';
 
+/**
+ * The faker instance for the `en_US` locale.
+ *
+ * - Language: English (United States)
+ * - Endonym: English (United States)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `en_US`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [en_US, en, base],
 });
diff --git a/src/locale/en_ZA.ts b/src/locale/en_ZA.ts
index a5de8756..31f8d164 100644
--- a/src/locale/en_ZA.ts
+++ b/src/locale/en_ZA.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import en_ZA from '../locales/en_ZA';
 
+/**
+ * The faker instance for the `en_ZA` locale.
+ *
+ * - Language: English (South Africa)
+ * - Endonym: English (South Africa)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `en_ZA`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [en_ZA, en, base],
 });
diff --git a/src/locale/eo.ts b/src/locale/eo.ts
index c2344b4c..0db814cb 100644
--- a/src/locale/eo.ts
+++ b/src/locale/eo.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import eo from '../locales/eo';
 
+/**
+ * The faker instance for the `eo` locale.
+ *
+ * - Language: Esperanto
+ * - Endonym: Esperanto
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `eo`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [eo, en, base],
 });
diff --git a/src/locale/es.ts b/src/locale/es.ts
index f206bec0..762207ae 100644
--- a/src/locale/es.ts
+++ b/src/locale/es.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import es from '../locales/es';
 
+/**
+ * The faker instance for the `es` locale.
+ *
+ * - Language: Spanish
+ * - Endonym: Español
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `es`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [es, en, base],
 });
diff --git a/src/locale/es_MX.ts b/src/locale/es_MX.ts
index d59a239b..c1dd879b 100644
--- a/src/locale/es_MX.ts
+++ b/src/locale/es_MX.ts
@@ -9,6 +9,19 @@ import en from '../locales/en';
 import es from '../locales/es';
 import es_MX from '../locales/es_MX';
 
+/**
+ * The faker instance for the `es_MX` locale.
+ *
+ * - Language: Spanish (Mexico)
+ * - Endonym: Español (México)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `es_MX`
+ * - `es`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [es_MX, es, en, base],
 });
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],
 });
diff --git a/src/locale/fi.ts b/src/locale/fi.ts
index 1125d54b..d9c410b4 100644
--- a/src/locale/fi.ts
+++ b/src/locale/fi.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import fi from '../locales/fi';
 
+/**
+ * The faker instance for the `fi` locale.
+ *
+ * - Language: Finnish
+ * - Endonym: suomi
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `fi`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [fi, en, base],
 });
diff --git a/src/locale/fr.ts b/src/locale/fr.ts
index f9a76f46..c0352eff 100644
--- a/src/locale/fr.ts
+++ b/src/locale/fr.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import fr from '../locales/fr';
 
+/**
+ * The faker instance for the `fr` locale.
+ *
+ * - Language: French
+ * - Endonym: Français
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `fr`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [fr, en, base],
 });
diff --git a/src/locale/fr_BE.ts b/src/locale/fr_BE.ts
index d0a6536f..58fcccfa 100644
--- a/src/locale/fr_BE.ts
+++ b/src/locale/fr_BE.ts
@@ -9,6 +9,19 @@ import en from '../locales/en';
 import fr from '../locales/fr';
 import fr_BE from '../locales/fr_BE';
 
+/**
+ * The faker instance for the `fr_BE` locale.
+ *
+ * - Language: French (Belgium)
+ * - Endonym: Français (Belgique)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `fr_BE`
+ * - `fr`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [fr_BE, fr, en, base],
 });
diff --git a/src/locale/fr_CA.ts b/src/locale/fr_CA.ts
index cb30f751..2f9e4d28 100644
--- a/src/locale/fr_CA.ts
+++ b/src/locale/fr_CA.ts
@@ -9,6 +9,19 @@ import en from '../locales/en';
 import fr from '../locales/fr';
 import fr_CA from '../locales/fr_CA';
 
+/**
+ * The faker instance for the `fr_CA` locale.
+ *
+ * - Language: French (Canada)
+ * - Endonym: Français (Canada)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `fr_CA`
+ * - `fr`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [fr_CA, fr, en, base],
 });
diff --git a/src/locale/fr_CH.ts b/src/locale/fr_CH.ts
index 6301439a..86774f88 100644
--- a/src/locale/fr_CH.ts
+++ b/src/locale/fr_CH.ts
@@ -9,6 +9,19 @@ import en from '../locales/en';
 import fr from '../locales/fr';
 import fr_CH from '../locales/fr_CH';
 
+/**
+ * The faker instance for the `fr_CH` locale.
+ *
+ * - Language: French (Switzerland)
+ * - Endonym: Français (Suisse)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `fr_CH`
+ * - `fr`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [fr_CH, fr, en, base],
 });
diff --git a/src/locale/fr_LU.ts b/src/locale/fr_LU.ts
index b2d5a0e7..5a0bd9c2 100644
--- a/src/locale/fr_LU.ts
+++ b/src/locale/fr_LU.ts
@@ -9,6 +9,19 @@ import en from '../locales/en';
 import fr from '../locales/fr';
 import fr_LU from '../locales/fr_LU';
 
+/**
+ * The faker instance for the `fr_LU` locale.
+ *
+ * - Language: French (Luxembourg)
+ * - Endonym: Français (Luxembourg)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `fr_LU`
+ * - `fr`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [fr_LU, fr, en, base],
 });
diff --git a/src/locale/fr_SN.ts b/src/locale/fr_SN.ts
index 13f50a4e..2d724d1b 100644
--- a/src/locale/fr_SN.ts
+++ b/src/locale/fr_SN.ts
@@ -9,6 +9,19 @@ import en from '../locales/en';
 import fr from '../locales/fr';
 import fr_SN from '../locales/fr_SN';
 
+/**
+ * The faker instance for the `fr_SN` locale.
+ *
+ * - Language: French (Senegal)
+ * - Endonym: Français (Sénégal)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `fr_SN`
+ * - `fr`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [fr_SN, fr, en, base],
 });
diff --git a/src/locale/he.ts b/src/locale/he.ts
index fb8557cc..63eb99a5 100644
--- a/src/locale/he.ts
+++ b/src/locale/he.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import he from '../locales/he';
 
+/**
+ * The faker instance for the `he` locale.
+ *
+ * - Language: Hebrew
+ * - Endonym: עברית
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `he`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [he, en, base],
 });
diff --git a/src/locale/hr.ts b/src/locale/hr.ts
index b5ed8516..6aa1458f 100644
--- a/src/locale/hr.ts
+++ b/src/locale/hr.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import hr from '../locales/hr';
 
+/**
+ * The faker instance for the `hr` locale.
+ *
+ * - Language: Croatian
+ * - Endonym: Hrvatski
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `hr`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [hr, en, base],
 });
diff --git a/src/locale/hu.ts b/src/locale/hu.ts
index 72b31b17..26dc4dda 100644
--- a/src/locale/hu.ts
+++ b/src/locale/hu.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import hu from '../locales/hu';
 
+/**
+ * The faker instance for the `hu` locale.
+ *
+ * - Language: Hungarian
+ * - Endonym: magyar
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `hu`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [hu, en, base],
 });
diff --git a/src/locale/hy.ts b/src/locale/hy.ts
index c908e938..7f71a0c5 100644
--- a/src/locale/hy.ts
+++ b/src/locale/hy.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import hy from '../locales/hy';
 
+/**
+ * The faker instance for the `hy` locale.
+ *
+ * - Language: Armenian
+ * - Endonym: Հայերեն
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `hy`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [hy, en, base],
 });
diff --git a/src/locale/id_ID.ts b/src/locale/id_ID.ts
index 076fe67e..0a423400 100644
--- a/src/locale/id_ID.ts
+++ b/src/locale/id_ID.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import id_ID from '../locales/id_ID';
 
+/**
+ * The faker instance for the `id_ID` locale.
+ *
+ * - Language: Indonesian (Indonesia)
+ * - Endonym: Bahasa Indonesia (Indonesia)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `id_ID`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [id_ID, en, base],
 });
diff --git a/src/locale/it.ts b/src/locale/it.ts
index 4dc16ac1..822a24fb 100644
--- a/src/locale/it.ts
+++ b/src/locale/it.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import it from '../locales/it';
 
+/**
+ * The faker instance for the `it` locale.
+ *
+ * - Language: Italian
+ * - Endonym: Italiano
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `it`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [it, en, base],
 });
diff --git a/src/locale/ja.ts b/src/locale/ja.ts
index 1a204077..6760a982 100644
--- a/src/locale/ja.ts
+++ b/src/locale/ja.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import ja from '../locales/ja';
 
+/**
+ * The faker instance for the `ja` locale.
+ *
+ * - Language: Japanese
+ * - Endonym: 日本語
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `ja`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [ja, en, base],
 });
diff --git a/src/locale/ka_GE.ts b/src/locale/ka_GE.ts
index 8f32405f..89c43309 100644
--- a/src/locale/ka_GE.ts
+++ b/src/locale/ka_GE.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import ka_GE from '../locales/ka_GE';
 
+/**
+ * The faker instance for the `ka_GE` locale.
+ *
+ * - Language: Georgian (Georgia)
+ * - Endonym: ქართული (საქართველო)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `ka_GE`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [ka_GE, en, base],
 });
diff --git a/src/locale/ko.ts b/src/locale/ko.ts
index baf5593d..b28291ce 100644
--- a/src/locale/ko.ts
+++ b/src/locale/ko.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import ko from '../locales/ko';
 
+/**
+ * The faker instance for the `ko` locale.
+ *
+ * - Language: Korean
+ * - Endonym: 한국어
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `ko`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [ko, en, base],
 });
diff --git a/src/locale/lv.ts b/src/locale/lv.ts
index 486d5e16..ebc30d35 100644
--- a/src/locale/lv.ts
+++ b/src/locale/lv.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import lv from '../locales/lv';
 
+/**
+ * The faker instance for the `lv` locale.
+ *
+ * - Language: Latvian
+ * - Endonym: latviešu valoda
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `lv`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [lv, en, base],
 });
diff --git a/src/locale/mk.ts b/src/locale/mk.ts
index 18c2562b..e6ef1b03 100644
--- a/src/locale/mk.ts
+++ b/src/locale/mk.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import mk from '../locales/mk';
 
+/**
+ * The faker instance for the `mk` locale.
+ *
+ * - Language: Macedonian
+ * - Endonym: македонски јазик
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `mk`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [mk, en, base],
 });
diff --git a/src/locale/nb_NO.ts b/src/locale/nb_NO.ts
index d1d417b6..e46c0335 100644
--- a/src/locale/nb_NO.ts
+++ b/src/locale/nb_NO.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import nb_NO from '../locales/nb_NO';
 
+/**
+ * The faker instance for the `nb_NO` locale.
+ *
+ * - Language: Norwegian (Norway)
+ * - Endonym: Norsk bokmål (Norge)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `nb_NO`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [nb_NO, en, base],
 });
diff --git a/src/locale/ne.ts b/src/locale/ne.ts
index 4343180b..8c071562 100644
--- a/src/locale/ne.ts
+++ b/src/locale/ne.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import ne from '../locales/ne';
 
+/**
+ * The faker instance for the `ne` locale.
+ *
+ * - Language: Nepali
+ * - Endonym: नेपाली
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `ne`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [ne, en, base],
 });
diff --git a/src/locale/nl.ts b/src/locale/nl.ts
index 19768256..32db5f37 100644
--- a/src/locale/nl.ts
+++ b/src/locale/nl.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import nl from '../locales/nl';
 
+/**
+ * The faker instance for the `nl` locale.
+ *
+ * - Language: Dutch
+ * - Endonym: Nederlands
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `nl`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [nl, en, base],
 });
diff --git a/src/locale/nl_BE.ts b/src/locale/nl_BE.ts
index 55c24d0a..cac43547 100644
--- a/src/locale/nl_BE.ts
+++ b/src/locale/nl_BE.ts
@@ -9,6 +9,19 @@ import en from '../locales/en';
 import nl from '../locales/nl';
 import nl_BE from '../locales/nl_BE';
 
+/**
+ * The faker instance for the `nl_BE` locale.
+ *
+ * - Language: Dutch (Belgium)
+ * - Endonym: Nederlands (België)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `nl_BE`
+ * - `nl`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [nl_BE, nl, en, base],
 });
diff --git a/src/locale/pl.ts b/src/locale/pl.ts
index 86cec2e8..8ddb0b88 100644
--- a/src/locale/pl.ts
+++ b/src/locale/pl.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import pl from '../locales/pl';
 
+/**
+ * The faker instance for the `pl` locale.
+ *
+ * - Language: Polish
+ * - Endonym: Polski
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `pl`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [pl, en, base],
 });
diff --git a/src/locale/pt_BR.ts b/src/locale/pt_BR.ts
index 31617b6c..20a9aa21 100644
--- a/src/locale/pt_BR.ts
+++ b/src/locale/pt_BR.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import pt_BR from '../locales/pt_BR';
 
+/**
+ * The faker instance for the `pt_BR` locale.
+ *
+ * - Language: Portuguese (Brazil)
+ * - Endonym: Português (Brasil)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `pt_BR`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [pt_BR, en, base],
 });
diff --git a/src/locale/pt_PT.ts b/src/locale/pt_PT.ts
index b8a1298b..9eb090e6 100644
--- a/src/locale/pt_PT.ts
+++ b/src/locale/pt_PT.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import pt_PT from '../locales/pt_PT';
 
+/**
+ * The faker instance for the `pt_PT` locale.
+ *
+ * - Language: Portuguese (Portugal)
+ * - Endonym: Português (Portugal)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `pt_PT`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [pt_PT, en, base],
 });
diff --git a/src/locale/ro.ts b/src/locale/ro.ts
index 94d593ed..d692a442 100644
--- a/src/locale/ro.ts
+++ b/src/locale/ro.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import ro from '../locales/ro';
 
+/**
+ * The faker instance for the `ro` locale.
+ *
+ * - Language: Romanian
+ * - Endonym: Română
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `ro`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [ro, en, base],
 });
diff --git a/src/locale/ro_MD.ts b/src/locale/ro_MD.ts
index c67c7025..da49ee1d 100644
--- a/src/locale/ro_MD.ts
+++ b/src/locale/ro_MD.ts
@@ -9,6 +9,19 @@ import en from '../locales/en';
 import ro from '../locales/ro';
 import ro_MD from '../locales/ro_MD';
 
+/**
+ * The faker instance for the `ro_MD` locale.
+ *
+ * - Language: Romanian (Moldova)
+ * - Endonym: Română (Moldova)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `ro_MD`
+ * - `ro`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [ro_MD, ro, en, base],
 });
diff --git a/src/locale/ru.ts b/src/locale/ru.ts
index f97df221..c5bd2750 100644
--- a/src/locale/ru.ts
+++ b/src/locale/ru.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import ru from '../locales/ru';
 
+/**
+ * The faker instance for the `ru` locale.
+ *
+ * - Language: Russian
+ * - Endonym: Русский
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `ru`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [ru, en, base],
 });
diff --git a/src/locale/sk.ts b/src/locale/sk.ts
index 59271d5a..3cd7e6c4 100644
--- a/src/locale/sk.ts
+++ b/src/locale/sk.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import sk from '../locales/sk';
 
+/**
+ * The faker instance for the `sk` locale.
+ *
+ * - Language: Slovak
+ * - Endonym: slovenčina
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `sk`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [sk, en, base],
 });
diff --git a/src/locale/sr_RS_latin.ts b/src/locale/sr_RS_latin.ts
index 692928f8..6122541d 100644
--- a/src/locale/sr_RS_latin.ts
+++ b/src/locale/sr_RS_latin.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import sr_RS_latin from '../locales/sr_RS_latin';
 
+/**
+ * The faker instance for the `sr_RS_latin` locale.
+ *
+ * - Language: Serbian (Serbia, Latin)
+ * - Endonym: srpski (Srbija, latinica)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `sr_RS_latin`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [sr_RS_latin, en, base],
 });
diff --git a/src/locale/sv.ts b/src/locale/sv.ts
index 1df3eb17..372250f9 100644
--- a/src/locale/sv.ts
+++ b/src/locale/sv.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import sv from '../locales/sv';
 
+/**
+ * The faker instance for the `sv` locale.
+ *
+ * - Language: Swedish
+ * - Endonym: Svenska
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `sv`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [sv, en, base],
 });
diff --git a/src/locale/th.ts b/src/locale/th.ts
index 73ff56ad..0e0015d3 100644
--- a/src/locale/th.ts
+++ b/src/locale/th.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import th from '../locales/th';
 
+/**
+ * The faker instance for the `th` locale.
+ *
+ * - Language: Thai
+ * - Endonym: ไทย
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `th`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [th, en, base],
 });
diff --git a/src/locale/tr.ts b/src/locale/tr.ts
index ee359ae5..9ac44f39 100644
--- a/src/locale/tr.ts
+++ b/src/locale/tr.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import tr from '../locales/tr';
 
+/**
+ * The faker instance for the `tr` locale.
+ *
+ * - Language: Turkish
+ * - Endonym: Türkçe
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `tr`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [tr, en, base],
 });
diff --git a/src/locale/uk.ts b/src/locale/uk.ts
index 8a6db1f7..1881c9cd 100644
--- a/src/locale/uk.ts
+++ b/src/locale/uk.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import uk from '../locales/uk';
 
+/**
+ * The faker instance for the `uk` locale.
+ *
+ * - Language: Ukrainian
+ * - Endonym: Українська
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `uk`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [uk, en, base],
 });
diff --git a/src/locale/ur.ts b/src/locale/ur.ts
index f7f5bf20..57769cf3 100644
--- a/src/locale/ur.ts
+++ b/src/locale/ur.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import ur from '../locales/ur';
 
+/**
+ * The faker instance for the `ur` locale.
+ *
+ * - Language: Urdu
+ * - Endonym: اردو
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `ur`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [ur, en, base],
 });
diff --git a/src/locale/uz_UZ_latin.ts b/src/locale/uz_UZ_latin.ts
index 5bddc232..0c4aebbd 100644
--- a/src/locale/uz_UZ_latin.ts
+++ b/src/locale/uz_UZ_latin.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import uz_UZ_latin from '../locales/uz_UZ_latin';
 
+/**
+ * The faker instance for the `uz_UZ_latin` locale.
+ *
+ * - Language: Uzbek (Uzbekistan, Latin)
+ * - Endonym: O'zbekcha
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `uz_UZ_latin`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [uz_UZ_latin, en, base],
 });
diff --git a/src/locale/vi.ts b/src/locale/vi.ts
index 8ec561a8..47785ab9 100644
--- a/src/locale/vi.ts
+++ b/src/locale/vi.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import vi from '../locales/vi';
 
+/**
+ * The faker instance for the `vi` locale.
+ *
+ * - Language: Vietnamese
+ * - Endonym: Tiếng Việt
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `vi`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [vi, en, base],
 });
diff --git a/src/locale/yo_NG.ts b/src/locale/yo_NG.ts
index 27e03f56..bceb9b6f 100644
--- a/src/locale/yo_NG.ts
+++ b/src/locale/yo_NG.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import yo_NG from '../locales/yo_NG';
 
+/**
+ * The faker instance for the `yo_NG` locale.
+ *
+ * - Language: Yoruba (Nigeria)
+ * - Endonym: Yoruba (Naijiria)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `yo_NG`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [yo_NG, en, base],
 });
diff --git a/src/locale/zh_CN.ts b/src/locale/zh_CN.ts
index 8a6a4073..b92ae23b 100644
--- a/src/locale/zh_CN.ts
+++ b/src/locale/zh_CN.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import zh_CN from '../locales/zh_CN';
 
+/**
+ * The faker instance for the `zh_CN` locale.
+ *
+ * - Language: Chinese (China)
+ * - Endonym: 中文 (中国)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `zh_CN`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [zh_CN, en, base],
 });
diff --git a/src/locale/zh_TW.ts b/src/locale/zh_TW.ts
index 00df2c62..97dfc2ea 100644
--- a/src/locale/zh_TW.ts
+++ b/src/locale/zh_TW.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import zh_TW from '../locales/zh_TW';
 
+/**
+ * The faker instance for the `zh_TW` locale.
+ *
+ * - Language: Chinese (Taiwan)
+ * - Endonym: 中文 (臺灣)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `zh_TW`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [zh_TW, en, base],
 });
diff --git a/src/locale/zu_ZA.ts b/src/locale/zu_ZA.ts
index 5da3d828..4286e9c4 100644
--- a/src/locale/zu_ZA.ts
+++ b/src/locale/zu_ZA.ts
@@ -8,6 +8,18 @@ import base from '../locales/base';
 import en from '../locales/en';
 import zu_ZA from '../locales/zu_ZA';
 
+/**
+ * The faker instance for the `zu_ZA` locale.
+ *
+ * - Language: Zulu (South Africa)
+ * - Endonym: isiZulu (Iningizimu Afrika)
+ *
+ * This instance uses the following locales internally (in descending precedence):
+ *
+ * - `zu_ZA`
+ * - `en`
+ * - `base`
+ */
 export const faker = new Faker({
   locale: [zu_ZA, en, base],
 });