feat: return dictionary from element()

faker-js · May 29, 2022 · 727776a · 727776a
1 parent db2f011
commit 727776a
Showing 1 changed file with 13 additions and 18 deletions.
diff --git a/src/modules/science/index.ts b/src/modules/science/index.ts
@@ -1,5 +1,10 @@
 import type { Faker } from '../..';
 
+export type Element = {
+  name: string;
+  symbol: string;
+};
+
 /**
  * Module to generate science related entries.
  */
@@ -15,27 +20,17 @@ export class Science {
   }
 
   /**
-   * Returns a random element name.
-   *
-   * @example
-   * faker.science.elementName() // 'Praseodymium'
-   */
-  elementName(): string {
-    return this.faker.helpers.arrayElement(
-      this.faker.definitions.science.chemicalElement
-    ).name;
-  }
-
-  /**
-   * Returns a random element symbol.
+   * Returns a random element.
    *
    * @example
-   * faker.science.elementSymbol() // 'Rg'
+   * faker.science.element() // { name: 'Hydrogen', symbol: 'H' }
    */
-  elementSymbol(): string {
-    return this.faker.helpers.arrayElement(
-      this.faker.definitions.science.chemicalElement
-    ).symbol;
+  element(): Element {
+    const index = this.faker.datatype.number({ min: 0, max: 117 });
+    return {
+      name: this.faker.definitions.science.chemicalElement[index].name,
+      symbol: this.faker.definitions.science.chemicalElement[index].symbol,
+    };
   }
 
   /**