diff options
139 files changed, 1307 insertions, 9 deletions
diff --git a/scripts/generate-locales.ts b/scripts/generate-locales.ts index e18bdb71..13fe70fd 100644 --- a/scripts/generate-locales.ts +++ b/scripts/generate-locales.ts @@ -112,6 +112,21 @@ function escapeField(parent: string, module: string): string { return module; } +async function loadMetadata(locale: string): Promise<MetadataDefinition> { + const imported = await import( + `file:${resolve(pathLocales, locale, 'metadata.ts')}` + ); + return imported.default as MetadataDefinition; +} + +async function tryLoadMetadata(locale: string): Promise<MetadataDefinition> { + try { + return await loadMetadata(locale); + } catch { + return {}; + } +} + async function generateLocaleFile(locale: string): Promise<void> { const parts = locale.split('_'); const locales = [locale]; @@ -135,14 +150,33 @@ async function generateLocaleFile(locale: string): Promise<void> { locales.push('base'); } - let content = ` + const metadata = await tryLoadMetadata(locale); + + const imports = `import { Faker } from '../faker'; +${locales.map((imp) => `import ${imp} from '../locales/${imp}';`).join('\n')}`; + + const jsdoc = + locale === '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.` + : `The faker instance for the \`${locale}\` locale. + +- Language: ${metadata.title} +- Endonym: ${metadata.endonym} + +This instance uses the following locales internally (in descending precedence): + +${locales.map((locale) => `- \`${locale}\``).join('\n')}`; + + const content = ` ${autoGeneratedCommentHeader} - import { Faker } from '../faker'; - ${locales - .map((imp) => `import ${imp} from '../locales/${imp}';`) - .join('\n')} + ${imports} + /** + * ${jsdoc.replaceAll('\n', '\n * ')} + */ export const faker = new Faker({ locale: ${ locales.length === 1 ? locales[0] : `[${locales.join(', ')}]` @@ -150,8 +184,10 @@ async function generateLocaleFile(locale: string): Promise<void> { }); `; - content = await formatTypescript(content); - return writeFile(resolve(pathLocale, `${locale}.ts`), content); + return writeFile( + resolve(pathLocale, `${locale}.ts`), + await formatTypescript(content) + ); } async function generateLocalesIndexFile( @@ -166,6 +202,24 @@ async function generateLocalesIndexFile( modules = removeTsSuffix(modules); modules.sort(); + const metadata = depth === 1 ? await tryLoadMetadata(name) : {}; + + const jsdoc = + depth === 1 + ? name === 'base' + ? `/** + * The locale data for the \`base\` locale. + * + * The base locale contains data that is shared across all locales such as ISO codes, time zones, and more. + */` + : `/** + * The locale data for the \`${name}\` locale. + * + * - Language: ${metadata.title} + * - Endonym: ${metadata.endonym} + */` + : ''; + const content = [autoGeneratedCommentHeader]; let fieldType = ''; if (type !== 'any') { @@ -182,6 +236,7 @@ async function generateLocalesIndexFile( (module) => `import ${escapeImport(name, module)} from './${module}';` ), '', + jsdoc, `const ${name}${fieldType} = { ${modules.map((module) => `${escapeField(name, module)},`).join('\n')} };`, @@ -385,8 +440,7 @@ for (const locale of locales) { const pathMetadata = resolve(pathModules, 'metadata.ts'); let localeTitle = 'No title found'; try { - const metadataImport = await import(`file:${pathMetadata}`); - const metadata: MetadataDefinition = metadataImport.default; + const metadata: MetadataDefinition = await loadMetadata(locale); const { title } = metadata; if (!title) { throw new Error(`No title property found on ${JSON.stringify(metadata)}`); 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], }); diff --git a/src/locales/af_ZA/index.ts b/src/locales/af_ZA/index.ts index 3bde3758..e1d1a8f9 100644 --- a/src/locales/af_ZA/index.ts +++ b/src/locales/af_ZA/index.ts @@ -11,6 +11,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `af_ZA` locale. + * + * - Language: Afrikaans (South Africa) + * - Endonym: Afrikaans (Suid-Afrika) + */ const af_ZA: LocaleDefinition = { cell_phone, company, diff --git a/src/locales/ar/index.ts b/src/locales/ar/index.ts index 6d7b46e0..62a98aef 100644 --- a/src/locales/ar/index.ts +++ b/src/locales/ar/index.ts @@ -14,6 +14,12 @@ import person from './person'; import team from './team'; import vehicle from './vehicle'; +/** + * The locale data for the `ar` locale. + * + * - Language: Arabic + * - Endonym: اَلْعَرَبِيَّةُ + */ const ar: LocaleDefinition = { cell_phone, color, diff --git a/src/locales/az/index.ts b/src/locales/az/index.ts index 923480de..9155e125 100644 --- a/src/locales/az/index.ts +++ b/src/locales/az/index.ts @@ -13,6 +13,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `az` locale. + * + * - Language: Azerbaijani + * - Endonym: azərbaycan dili + */ const az: LocaleDefinition = { color, commerce, diff --git a/src/locales/base/index.ts b/src/locales/base/index.ts index 0a031fbb..2e260172 100644 --- a/src/locales/base/index.ts +++ b/src/locales/base/index.ts @@ -12,6 +12,11 @@ import location from './location'; import metadata from './metadata'; import system from './system'; +/** + * The locale data for the `base` locale. + * + * The base locale contains data that is shared across all locales such as ISO codes, time zones, and more. + */ const base: LocaleDefinition = { color, database, diff --git a/src/locales/cs_CZ/index.ts b/src/locales/cs_CZ/index.ts index c3770c00..3f1be315 100644 --- a/src/locales/cs_CZ/index.ts +++ b/src/locales/cs_CZ/index.ts @@ -12,6 +12,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `cs_CZ` locale. + * + * - Language: Czech (Czechia) + * - Endonym: čeština (Česká republika) + */ const cs_CZ: LocaleDefinition = { company, date, diff --git a/src/locales/da/index.ts b/src/locales/da/index.ts index d2335413..d454db43 100644 --- a/src/locales/da/index.ts +++ b/src/locales/da/index.ts @@ -13,6 +13,12 @@ import person from './person'; import phone_number from './phone_number'; import word from './word'; +/** + * The locale data for the `da` locale. + * + * - Language: Danish + * - Endonym: Dansk + */ const da: LocaleDefinition = { commerce, company, diff --git a/src/locales/de/index.ts b/src/locales/de/index.ts index 4bdeb76f..a64e7755 100644 --- a/src/locales/de/index.ts +++ b/src/locales/de/index.ts @@ -16,6 +16,12 @@ import person from './person'; import phone_number from './phone_number'; import word from './word'; +/** + * The locale data for the `de` locale. + * + * - Language: German + * - Endonym: Deutsch + */ const de: LocaleDefinition = { cell_phone, color, diff --git a/src/locales/de_AT/index.ts b/src/locales/de_AT/index.ts index 8ed90a8d..3b3f5c0e 100644 --- a/src/locales/de_AT/index.ts +++ b/src/locales/de_AT/index.ts @@ -12,6 +12,12 @@ import person from './person'; import phone_number from './phone_number'; import word from './word'; +/** + * The locale data for the `de_AT` locale. + * + * - Language: German (Austria) + * - Endonym: Deutsch (Österreich) + */ const de_AT: LocaleDefinition = { cell_phone, company, diff --git a/src/locales/de_CH/index.ts b/src/locales/de_CH/index.ts index ec19b44c..22c6465c 100644 --- a/src/locales/de_CH/index.ts +++ b/src/locales/de_CH/index.ts @@ -10,6 +10,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `de_CH` locale. + * + * - Language: German (Switzerland) + * - Endonym: Deutsch (Schweiz) + */ const de_CH: LocaleDefinition = { company, internet, diff --git a/src/locales/dv/index.ts b/src/locales/dv/index.ts index 1c534b6c..bddb4fc4 100644 --- a/src/locales/dv/index.ts +++ b/src/locales/dv/index.ts @@ -13,6 +13,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `dv` locale. + * + * - Language: Maldivian + * - Endonym: ދިވެހި + */ const dv: LocaleDefinition = { cell_phone, color, diff --git a/src/locales/el/index.ts b/src/locales/el/index.ts index 42a1f59a..80c132d6 100644 --- a/src/locales/el/index.ts +++ b/src/locales/el/index.ts @@ -18,6 +18,12 @@ import person from './person'; import phone_number from './phone_number'; import team from './team'; +/** + * The locale data for the `el` locale. + * + * - Language: Greek + * - Endonym: Ελληνικά + */ const el: LocaleDefinition = { app, cell_phone, diff --git a/src/locales/en/index.ts b/src/locales/en/index.ts index 7c932075..c84e786d 100644 --- a/src/locales/en/index.ts +++ b/src/locales/en/index.ts @@ -28,6 +28,12 @@ import team from './team'; import vehicle from './vehicle'; import word from './word'; +/** + * The locale data for the `en` locale. + * + * - Language: English + * - Endonym: English + */ const en: LocaleDefinition = { airline, animal, diff --git a/src/locales/en_AU/index.ts b/src/locales/en_AU/index.ts index ee3bf460..cab310d2 100644 --- a/src/locales/en_AU/index.ts +++ b/src/locales/en_AU/index.ts @@ -10,6 +10,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `en_AU` locale. + * + * - Language: English (Australia) + * - Endonym: English (Australia) + */ const en_AU: LocaleDefinition = { company, internet, diff --git a/src/locales/en_AU_ocker/index.ts b/src/locales/en_AU_ocker/index.ts index 0a15fa0d..c599542e 100644 --- a/src/locales/en_AU_ocker/index.ts +++ b/src/locales/en_AU_ocker/index.ts @@ -9,6 +9,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `en_AU_ocker` locale. + * + * - Language: English (Australia Ocker) + * - Endonym: English (Australia) + */ const en_AU_ocker: LocaleDefinition = { internet, location, diff --git a/src/locales/en_BORK/index.ts b/src/locales/en_BORK/index.ts index c214e7ae..2c0e46e0 100644 --- a/src/locales/en_BORK/index.ts +++ b/src/locales/en_BORK/index.ts @@ -7,6 +7,12 @@ import lorem from './lorem'; import metadata from './metadata'; import person from './person'; +/** + * The locale data for the `en_BORK` locale. + * + * - Language: English (Bork) + * - Endonym: English (Bork) + */ const en_BORK: LocaleDefinition = { lorem, metadata, diff --git a/src/locales/en_CA/index.ts b/src/locales/en_CA/index.ts index cb6dbd35..a2a690b8 100644 --- a/src/locales/en_CA/index.ts +++ b/src/locales/en_CA/index.ts @@ -9,6 +9,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `en_CA` locale. + * + * - Language: English (Canada) + * - Endonym: English (Canada) + */ const en_CA: LocaleDefinition = { internet, location, diff --git a/src/locales/en_GB/index.ts b/src/locales/en_GB/index.ts index ae59fada..5ef7c081 100644 --- a/src/locales/en_GB/index.ts +++ b/src/locales/en_GB/index.ts @@ -10,6 +10,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `en_GB` locale. + * + * - Language: English (Great Britain) + * - Endonym: English (Great Britain) + */ const en_GB: LocaleDefinition = { cell_phone, internet, diff --git a/src/locales/en_GH/index.ts b/src/locales/en_GH/index.ts index c4ca5da3..178e4ac7 100644 --- a/src/locales/en_GH/index.ts +++ b/src/locales/en_GH/index.ts @@ -10,6 +10,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `en_GH` locale. + * + * - Language: English (Ghana) + * - Endonym: English (Ghana) + */ const en_GH: LocaleDefinition = { company, internet, diff --git a/src/locales/en_HK/index.ts b/src/locales/en_HK/index.ts index cbbfed81..d164a40f 100644 --- a/src/locales/en_HK/index.ts +++ b/src/locales/en_HK/index.ts @@ -10,6 +10,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `en_HK` locale. + * + * - Language: English (Hong Kong) + * - Endonym: English (Hong Kong) + */ const en_HK: LocaleDefinition = { company, internet, diff --git a/src/locales/en_IE/index.ts b/src/locales/en_IE/index.ts index c54df543..76f87a93 100644 --- a/src/locales/en_IE/index.ts +++ b/src/locales/en_IE/index.ts @@ -10,6 +10,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `en_IE` locale. + * + * - Language: English (Ireland) + * - Endonym: English (Ireland) + */ const en_IE: LocaleDefinition = { cell_phone, internet, diff --git a/src/locales/en_IN/index.ts b/src/locales/en_IN/index.ts index df86966d..f5d51b53 100644 --- a/src/locales/en_IN/index.ts +++ b/src/locales/en_IN/index.ts @@ -10,6 +10,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `en_IN` locale. + * + * - Language: English (India) + * - Endonym: English (India) + */ const en_IN: LocaleDefinition = { company, internet, diff --git a/src/locales/en_NG/index.ts b/src/locales/en_NG/index.ts index 5831d9e1..e7b1567c 100644 --- a/src/locales/en_NG/index.ts +++ b/src/locales/en_NG/index.ts @@ -10,6 +10,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `en_NG` locale. + * + * - Language: English (Nigeria) + * - Endonym: English (Nigeria) + */ const en_NG: LocaleDefinition = { company, internet, diff --git a/src/locales/en_US/index.ts b/src/locales/en_US/index.ts index ddadf9c8..ee9f825c 100644 --- a/src/locales/en_US/index.ts +++ b/src/locales/en_US/index.ts @@ -9,6 +9,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `en_US` locale. + * + * - Language: English (United States) + * - Endonym: English (United States) + */ const en_US: LocaleDefinition = { internet, location, diff --git a/src/locales/en_ZA/index.ts b/src/locales/en_ZA/index.ts index 43199703..80fd9d8a 100644 --- a/src/locales/en_ZA/index.ts +++ b/src/locales/en_ZA/index.ts @@ -11,6 +11,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `en_ZA` locale. + * + * - Language: English (South Africa) + * - Endonym: English (South Africa) + */ const en_ZA: LocaleDefinition = { cell_phone, company, diff --git a/src/locales/eo/index.ts b/src/locales/eo/index.ts index 83141fb2..5b5e4ed2 100644 --- a/src/locales/eo/index.ts +++ b/src/locales/eo/index.ts @@ -15,6 +15,12 @@ import person from './person'; import science from './science'; import vehicle from './vehicle'; +/** + * The locale data for the `eo` locale. + * + * - Language: Esperanto + * - Endonym: Esperanto + */ const eo: LocaleDefinition = { animal, color, diff --git a/src/locales/es/index.ts b/src/locales/es/index.ts index 880d4dee..f7fef2c7 100644 --- a/src/locales/es/index.ts +++ b/src/locales/es/index.ts @@ -14,6 +14,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `es` locale. + * + * - Language: Spanish + * - Endonym: Español + */ const es: LocaleDefinition = { cell_phone, color, diff --git a/src/locales/es_MX/index.ts b/src/locales/es_MX/index.ts index 334e8e5a..425632d0 100644 --- a/src/locales/es_MX/index.ts +++ b/src/locales/es_MX/index.ts @@ -15,6 +15,12 @@ import person from './person'; import phone_number from './phone_number'; import team from './team'; +/** + * The locale data for the `es_MX` locale. + * + * - Language: Spanish (Mexico) + * - Endonym: Español (México) + */ const es_MX: LocaleDefinition = { cell_phone, color, diff --git a/src/locales/fa/index.ts b/src/locales/fa/index.ts index 910711be..0b07f4fa 100644 --- a/src/locales/fa/index.ts +++ b/src/locales/fa/index.ts @@ -19,6 +19,12 @@ import phone_number from './phone_number'; import vehicle from './vehicle'; import word from './word'; +/** + * The locale data for the `fa` locale. + * + * - Language: Farsi/Persian + * - Endonym: فارسی + */ const fa: LocaleDefinition = { cell_phone, color, diff --git a/src/locales/fi/index.ts b/src/locales/fi/index.ts index 73dabe6f..b8e287d3 100644 --- a/src/locales/fi/index.ts +++ b/src/locales/fi/index.ts @@ -7,6 +7,12 @@ import location from './location'; import metadata from './metadata'; import person from './person'; +/** + * The locale data for the `fi` locale. + * + * - Language: Finnish + * - Endonym: suomi + */ const fi: LocaleDefinition = { location, metadata, diff --git a/src/locales/fr/index.ts b/src/locales/fr/index.ts index 2c8874fa..f1de2300 100644 --- a/src/locales/fr/index.ts +++ b/src/locales/fr/index.ts @@ -19,6 +19,12 @@ import phone_number from './phone_number'; import vehicle from './vehicle'; import word from './word'; +/** + * The locale data for the `fr` locale. + * + * - Language: French + * - Endonym: Français + */ const fr: LocaleDefinition = { animal, color, diff --git a/src/locales/fr_BE/index.ts b/src/locales/fr_BE/index.ts index fb4ad649..8503bac8 100644 --- a/src/locales/fr_BE/index.ts +++ b/src/locales/fr_BE/index.ts @@ -10,6 +10,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `fr_BE` locale. + * + * - Language: French (Belgium) + * - Endonym: Français (Belgique) + */ const fr_BE: LocaleDefinition = { cell_phone, internet, diff --git a/src/locales/fr_CA/index.ts b/src/locales/fr_CA/index.ts index 0d4a749e..18843cea 100644 --- a/src/locales/fr_CA/index.ts +++ b/src/locales/fr_CA/index.ts @@ -9,6 +9,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `fr_CA` locale. + * + * - Language: French (Canada) + * - Endonym: Français (Canada) + */ const fr_CA: LocaleDefinition = { internet, location, diff --git a/src/locales/fr_CH/index.ts b/src/locales/fr_CH/index.ts index 36c67c18..9eec70e5 100644 --- a/src/locales/fr_CH/index.ts +++ b/src/locales/fr_CH/index.ts @@ -11,6 +11,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `fr_CH` locale. + * + * - Language: French (Switzerland) + * - Endonym: Français (Suisse) + */ const fr_CH: LocaleDefinition = { cell_phone, internet, diff --git a/src/locales/fr_LU/index.ts b/src/locales/fr_LU/index.ts index 63c2151d..4bcd1513 100644 --- a/src/locales/fr_LU/index.ts +++ b/src/locales/fr_LU/index.ts @@ -10,6 +10,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `fr_LU` locale. + * + * - Language: French (Luxembourg) + * - Endonym: Français (Luxembourg) + */ const fr_LU: LocaleDefinition = { cell_phone, internet, diff --git a/src/locales/fr_SN/index.ts b/src/locales/fr_SN/index.ts index 7b766e77..60a2608e 100644 --- a/src/locales/fr_SN/index.ts +++ b/src/locales/fr_SN/index.ts @@ -8,6 +8,12 @@ import location from './location'; import metadata from './metadata'; import person from './person'; +/** + * The locale data for the `fr_SN` locale. + * + * - Language: French (Senegal) + * - Endonym: Français (Sénégal) + */ const fr_SN: LocaleDefinition = { internet, location, diff --git a/src/locales/he/index.ts b/src/locales/he/index.ts index b6e5dd8b..96af387d 100644 --- a/src/locales/he/index.ts +++ b/src/locales/he/index.ts @@ -15,6 +15,12 @@ import music from './music'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `he` locale. + * + * - Language: Hebrew + * - Endonym: עברית + */ const he: LocaleDefinition = { cell_phone, color, diff --git a/src/locales/hr/index.ts b/src/locales/hr/index.ts index 5225cbc6..20cd5c6d 100644 --- a/src/locales/hr/index.ts +++ b/src/locales/hr/index.ts @@ -11,6 +11,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `hr` locale. + * + * - Language: Croatian + * - Endonym: Hrvatski + */ const hr: LocaleDefinition = { cell_phone, date, diff --git a/src/locales/hu/index.ts b/src/locales/hu/index.ts index 8ae89f48..2154c6d0 100644 --- a/src/locales/hu/index.ts +++ b/src/locales/hu/index.ts @@ -16,6 +16,12 @@ import person from './person'; import phone_number from './phone_number'; import word from './word'; +/** + * The locale data for the `hu` locale. + * + * - Language: Hungarian + * - Endonym: magyar + */ const hu: LocaleDefinition = { animal, color, diff --git a/src/locales/hy/index.ts b/src/locales/hy/index.ts index 2b8aef3e..592e5d90 100644 --- a/src/locales/hy/index.ts +++ b/src/locales/hy/index.ts @@ -12,6 +12,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `hy` locale. + * + * - Language: Armenian + * - Endonym: Հայերեն + */ const hy: LocaleDefinition = { color, date, diff --git a/src/locales/id_ID/index.ts b/src/locales/id_ID/index.ts index 4b9e7ad9..4b864625 100644 --- a/src/locales/id_ID/index.ts +++ b/src/locales/id_ID/index.ts @@ -11,6 +11,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `id_ID` locale. + * + * - Language: Indonesian (Indonesia) + * - Endonym: Bahasa Indonesia (Indonesia) + */ const id_ID: LocaleDefinition = { company, date, diff --git a/src/locales/it/index.ts b/src/locales/it/index.ts index 5e2af4e8..c97c7261 100644 --- a/src/locales/it/index.ts +++ b/src/locales/it/index.ts @@ -10,6 +10,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `it` locale. + * + * - Language: Italian + * - Endonym: Italiano + */ const it: LocaleDefinition = { company, internet, diff --git a/src/locales/ja/index.ts b/src/locales/ja/index.ts index b6d01961..8e6730c3 100644 --- a/src/locales/ja/index.ts +++ b/src/locales/ja/index.ts @@ -11,6 +11,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `ja` locale. + * + * - Language: Japanese + * - Endonym: 日本語 + */ const ja: LocaleDefinition = { cell_phone, company, diff --git a/src/locales/ka_GE/index.ts b/src/locales/ka_GE/index.ts index ea959663..b8146fdd 100644 --- a/src/locales/ka_GE/index.ts +++ b/src/locales/ka_GE/index.ts @@ -11,6 +11,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `ka_GE` locale. + * + * - Language: Georgian (Georgia) + * - Endonym: ქართული (საქართველო) + */ const ka_GE: LocaleDefinition = { cell_phone, company, diff --git a/src/locales/ko/index.ts b/src/locales/ko/index.ts index 48fc7bc9..3fd3a96b 100644 --- a/src/locales/ko/index.ts +++ b/src/locales/ko/index.ts @@ -14,6 +14,12 @@ import person from './person'; import phone_number from './phone_number'; import word from './word'; +/** + * The locale data for the `ko` locale. + * + * - Language: Korean + * - Endonym: 한국어 + */ const ko: LocaleDefinition = { color, company, diff --git a/src/locales/lv/index.ts b/src/locales/lv/index.ts index f9c9a72c..cc91593a 100644 --- a/src/locales/lv/index.ts +++ b/src/locales/lv/index.ts @@ -15,6 +15,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `lv` locale. + * + * - Language: Latvian + * - Endonym: latviešu valoda + */ const lv: LocaleDefinition = { cell_phone, color, diff --git a/src/locales/mk/index.ts b/src/locales/mk/index.ts index 68d5f6f4..78e543dd 100644 --- a/src/locales/mk/index.ts +++ b/src/locales/mk/index.ts @@ -12,6 +12,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `mk` locale. + * + * - Language: Macedonian + * - Endonym: македонски јазик + */ const mk: LocaleDefinition = { cell_phone, company, diff --git a/src/locales/nb_NO/index.ts b/src/locales/nb_NO/index.ts index d9fa3d48..a4747890 100644 --- a/src/locales/nb_NO/index.ts +++ b/src/locales/nb_NO/index.ts @@ -14,6 +14,12 @@ import phone_number from './phone_number'; import science from './science'; import word from './word'; +/** + * The locale data for the `nb_NO` locale. + * + * - Language: Norwegian (Norway) + * - Endonym: Norsk bokmål (Norge) + */ const nb_NO: LocaleDefinition = { color, commerce, diff --git a/src/locales/ne/index.ts b/src/locales/ne/index.ts index 451ad1cf..ab65258f 100644 --- a/src/locales/ne/index.ts +++ b/src/locales/ne/index.ts @@ -10,6 +10,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `ne` locale. + * + * - Language: Nepali + * - Endonym: नेपाली + */ const ne: LocaleDefinition = { company, internet, diff --git a/src/locales/nl/index.ts b/src/locales/nl/index.ts index b7039fc2..e0032a22 100644 --- a/src/locales/nl/index.ts +++ b/src/locales/nl/index.ts @@ -15,6 +15,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `nl` locale. + * + * - Language: Dutch + * - Endonym: Nederlands + */ const nl: LocaleDefinition = { color, commerce, diff --git a/src/locales/nl_BE/index.ts b/src/locales/nl_BE/index.ts index cc6da2f4..5ed6b99a 100644 --- a/src/locales/nl_BE/index.ts +++ b/src/locales/nl_BE/index.ts @@ -10,6 +10,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `nl_BE` locale. + * + * - Language: Dutch (Belgium) + * - Endonym: Nederlands (België) + */ const nl_BE: LocaleDefinition = { company, internet, diff --git a/src/locales/pl/index.ts b/src/locales/pl/index.ts index b05c5f4e..bc0a3636 100644 --- a/src/locales/pl/index.ts +++ b/src/locales/pl/index.ts @@ -18,6 +18,12 @@ import phone_number from './phone_number'; import science from './science'; import team from './team'; +/** + * The locale data for the `pl` locale. + * + * - Language: Polish + * - Endonym: Polski + */ const pl: LocaleDefinition = { animal, book, diff --git a/src/locales/pt_BR/index.ts b/src/locales/pt_BR/index.ts index d654ab9d..00236a9a 100644 --- a/src/locales/pt_BR/index.ts +++ b/src/locales/pt_BR/index.ts @@ -14,6 +14,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `pt_BR` locale. + * + * - Language: Portuguese (Brazil) + * - Endonym: Português (Brasil) + */ const pt_BR: LocaleDefinition = { color, commerce, diff --git a/src/locales/pt_PT/index.ts b/src/locales/pt_PT/index.ts index e60fe0ab..6f052da4 100644 --- a/src/locales/pt_PT/index.ts +++ b/src/locales/pt_PT/index.ts @@ -14,6 +14,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `pt_PT` locale. + * + * - Language: Portuguese (Portugal) + * - Endonym: Português (Portugal) + */ const pt_PT: LocaleDefinition = { cell_phone, color, diff --git a/src/locales/ro/index.ts b/src/locales/ro/index.ts index 87c61aa4..27ca849e 100644 --- a/src/locales/ro/index.ts +++ b/src/locales/ro/index.ts @@ -11,6 +11,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `ro` locale. + * + * - Language: Romanian + * - Endonym: Română + */ const ro: LocaleDefinition = { cell_phone, date, diff --git a/src/locales/ro_MD/index.ts b/src/locales/ro_MD/index.ts index 705ae65e..451ea9be 100644 --- a/src/locales/ro_MD/index.ts +++ b/src/locales/ro_MD/index.ts @@ -11,6 +11,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `ro_MD` locale. + * + * - Language: Romanian (Moldova) + * - Endonym: Română (Moldova) + */ const ro_MD: LocaleDefinition = { cell_phone, date, diff --git a/src/locales/ru/index.ts b/src/locales/ru/index.ts index e2e7d0e6..a696c22f 100644 --- a/src/locales/ru/index.ts +++ b/src/locales/ru/index.ts @@ -15,6 +15,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `ru` locale. + * + * - Language: Russian + * - Endonym: Русский + */ const ru: LocaleDefinition = { color, commerce, diff --git a/src/locales/sk/index.ts b/src/locales/sk/index.ts index 3f274dbd..f548144d 100644 --- a/src/locales/sk/index.ts +++ b/src/locales/sk/index.ts @@ -11,6 +11,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `sk` locale. + * + * - Language: Slovak + * - Endonym: slovenčina + */ const sk: LocaleDefinition = { company, internet, diff --git a/src/locales/sr_RS_latin/index.ts b/src/locales/sr_RS_latin/index.ts index caaef346..eb1feed8 100644 --- a/src/locales/sr_RS_latin/index.ts +++ b/src/locales/sr_RS_latin/index.ts @@ -11,6 +11,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `sr_RS_latin` locale. + * + * - Language: Serbian (Serbia, Latin) + * - Endonym: srpski (Srbija, latinica) + */ const sr_RS_latin: LocaleDefinition = { cell_phone, date, diff --git a/src/locales/sv/index.ts b/src/locales/sv/index.ts index c851468f..6eca718e 100644 --- a/src/locales/sv/index.ts +++ b/src/locales/sv/index.ts @@ -15,6 +15,12 @@ import person from './person'; import phone_number from './phone_number'; import team from './team'; +/** + * The locale data for the `sv` locale. + * + * - Language: Swedish + * - Endonym: Svenska + */ const sv: LocaleDefinition = { cell_phone, color, diff --git a/src/locales/th/index.ts b/src/locales/th/index.ts index fe9562c5..a28027ce 100644 --- a/src/locales/th/index.ts +++ b/src/locales/th/index.ts @@ -12,6 +12,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `th` locale. + * + * - Language: Thai + * - Endonym: ไทย + */ const th: LocaleDefinition = { animal, color, diff --git a/src/locales/tr/index.ts b/src/locales/tr/index.ts index b72e1854..a6c6d500 100644 --- a/src/locales/tr/index.ts +++ b/src/locales/tr/index.ts @@ -13,6 +13,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `tr` locale. + * + * - Language: Turkish + * - Endonym: Türkçe + */ const tr: LocaleDefinition = { cell_phone, color, diff --git a/src/locales/uk/index.ts b/src/locales/uk/index.ts index 31ba1899..4915b3c3 100644 --- a/src/locales/uk/index.ts +++ b/src/locales/uk/index.ts @@ -10,6 +10,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `uk` locale. + * + * - Language: Ukrainian + * - Endonym: Українська + */ const uk: LocaleDefinition = { company, internet, diff --git a/src/locales/ur/index.ts b/src/locales/ur/index.ts index f9fcaec8..4d5b3674 100644 --- a/src/locales/ur/index.ts +++ b/src/locales/ur/index.ts @@ -18,6 +18,12 @@ import person from './person'; import team from './team'; import vehicle from './vehicle'; +/** + * The locale data for the `ur` locale. + * + * - Language: Urdu + * - Endonym: اردو + */ const ur: LocaleDefinition = { animal, app, diff --git a/src/locales/uz_UZ_latin/index.ts b/src/locales/uz_UZ_latin/index.ts index af7692b2..ba1a956f 100644 --- a/src/locales/uz_UZ_latin/index.ts +++ b/src/locales/uz_UZ_latin/index.ts @@ -11,6 +11,12 @@ import lorem from './lorem'; import metadata from './metadata'; import person from './person'; +/** + * The locale data for the `uz_UZ_latin` locale. + * + * - Language: Uzbek (Uzbekistan, Latin) + * - Endonym: O'zbekcha + */ const uz_UZ_latin: LocaleDefinition = { color, commerce, diff --git a/src/locales/vi/index.ts b/src/locales/vi/index.ts index 519f1490..26f05187 100644 --- a/src/locales/vi/index.ts +++ b/src/locales/vi/index.ts @@ -13,6 +13,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `vi` locale. + * + * - Language: Vietnamese + * - Endonym: Tiếng Việt + */ const vi: LocaleDefinition = { cell_phone, company, diff --git a/src/locales/yo_NG/index.ts b/src/locales/yo_NG/index.ts index 967e785c..33a18948 100644 --- a/src/locales/yo_NG/index.ts +++ b/src/locales/yo_NG/index.ts @@ -6,6 +6,12 @@ import type { LocaleDefinition } from '../..'; import metadata from './metadata'; import person from './person'; +/** + * The locale data for the `yo_NG` locale. + * + * - Language: Yoruba (Nigeria) + * - Endonym: Yoruba (Naijiria) + */ const yo_NG: LocaleDefinition = { metadata, person, diff --git a/src/locales/zh_CN/index.ts b/src/locales/zh_CN/index.ts index 9666df9a..7f83558d 100644 --- a/src/locales/zh_CN/index.ts +++ b/src/locales/zh_CN/index.ts @@ -22,6 +22,12 @@ import science from './science'; import vehicle from './vehicle'; import word from './word'; +/** + * The locale data for the `zh_CN` locale. + * + * - Language: Chinese (China) + * - Endonym: 中文 (中国) + */ const zh_CN: LocaleDefinition = { airline, animal, diff --git a/src/locales/zh_TW/index.ts b/src/locales/zh_TW/index.ts index d837b7e0..17ae61ed 100644 --- a/src/locales/zh_TW/index.ts +++ b/src/locales/zh_TW/index.ts @@ -10,6 +10,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `zh_TW` locale. + * + * - Language: Chinese (Taiwan) + * - Endonym: 中文 (臺灣) + */ const zh_TW: LocaleDefinition = { color, date, diff --git a/src/locales/zu_ZA/index.ts b/src/locales/zu_ZA/index.ts index 0e86ac70..740d594e 100644 --- a/src/locales/zu_ZA/index.ts +++ b/src/locales/zu_ZA/index.ts @@ -11,6 +11,12 @@ import metadata from './metadata'; import person from './person'; import phone_number from './phone_number'; +/** + * The locale data for the `zu_ZA` locale. + * + * - Language: Zulu (South Africa) + * - Endonym: isiZulu (Iningizimu Afrika) + */ const zu_ZA: LocaleDefinition = { cell_phone, company, |