feat(metadata): add method to access metadata (#2143)

1 files changed, 14 insertions, 1 deletions

diff --git a/src/faker.ts b/src/faker.ts
index f227643e..cb56ea61 100644
--- a/src/faker.ts
+++ b/src/faker.ts
@@ -1,4 +1,4 @@
-import type { LocaleDefinition } from './definitions';
+import type { LocaleDefinition, MetadataDefinition } from './definitions';
 import { FakerError } from './errors/faker-error';
 import { deprecated } from './internal/deprecated';
 import type { Mersenne } from './internal/mersenne/mersenne';
@@ -458,6 +458,19 @@ export class Faker {
     return seed;
   }
 
+  /**
+   * Returns an object with metadata about the current locale.
+   *
+   * @example
+   * import { faker, fakerES_MX } from '@faker-js/faker';
+   * // const { faker, fakerES_MX } = require("@faker-js/faker")
+   * faker.getMetadata(); // { title: 'English', code: 'en', language: 'en', endonym: 'English', dir: 'ltr', script: 'Latn' }
+   * fakerES_MX.getMetadata(); // { title: 'Spanish (Mexico)', code: 'es_MX', language: 'es', endonym: 'Español (México)', dir: 'ltr', script: 'Latn', country: 'MX' }
+   */
+  getMetadata(): MetadataDefinition {
+    return this.rawDefinitions.metadata ?? {};
+  }
+
   // Pure JS backwards compatibility
 
   /**