feat(module): add new notations module for science

src/definitions/science.ts

@@ -1,4 +1,4 @@
-import type { ChemicalElement, Unit } from '../modules/science';
+import type { ChemicalElement, Notation, Unit } from '../modules/science';
 import type { LocaleEntry } from './definitions';
 
 /**
@@ -14,4 +14,9 @@
    * Some periodic table element information.
    */
   chemicalElement: ReadonlyArray<ChemicalElement>;
+
+  /**
+   * Some science notations
+   */
+  notation: ReadonlyArray<Notation>;
 }>;

src/locales/en/science/index.ts

@@ -4,10 +4,12 @@
  */
 import type { ScienceDefinition } from '../../..';
 import chemicalElement from './chemicalElement';
+import notation from './notation';
 import unit from './unit';
 
 const science: ScienceDefinition = {
   chemicalElement,
+  notation,
   unit,
 };
 

src/locales/en/science/notation.ts

@@ -0,0 +1,50 @@
+export default Object.freeze([
+  {
+    symbol: 'W',
+    name: 'work',
+  },
+  {
+    symbol: 'F',
+    name: 'force',
+  },
+  {
+    name: 'gravity',
+    symbol: 'G',
+  },
+  {
+    name: 'friction force',
+    symbol: 'f',
+  },
+  {
+    name: 'pressure',
+    symbol: 'P',
+  },
+  {
+    name: 'power',
+    symbol: 'P',
+  },
+  {
+    name: 'heat capacity',
+    symbol: 'c',
+  },
+  {
+    name: 'square',
+    symbol: 'S',
+  },
+  {
+    name: 'time',
+    symbol: 't',
+  },
+  {
+    name: 'velocity',
+    symbol: 'v',
+  },
+  {
+    name: 'volume',
+    symbol: 'V',
+  },
+  {
+    name: 'mass',
+    symbol: 'm',
+  },
+]);

src/modules/science/index.ts

@@ -29,6 +29,16 @@ export interface Unit {
   symbol: string;
 }
 
+export interface Notation {
+  /**
+   * The long version of the notations (e.g. `work`).
+   */
+  name: string;
+  /**
+   * The short version/abbreviation of the notations (e.g. `w`)
+   */
+  symbol: string;
+}
 /**
  * Module to generate science related entries.
  *
@@ -66,4 +76,20 @@ export class ScienceModule extends ModuleBase {
   unit(): Unit {
     return this.faker.helpers.arrayElement(this.faker.definitions.science.unit);
   }
+
+  /**
+   * Retunrs a ransom scientific notation.
+   *
+   * @example
+   * faker.science.notation() // { name: 'work', symbol: 'w' }
+   * faker.science.notation() // { name: 'force', symbol: 'F' }
+   * faker.science.notation() // { name: 'work', symbol: 'W'}
+   *
+   * @since 8.2.0
+   */
+  notation(): Notation {
+    return this.faker.helpers.arrayElement(
+      this.faker.definitions.science.notation
+    );
+  }
 }

test/modules/__snapshots__/science.spec.ts.snap

@@ -8,6 +8,13 @@ exports[`science > 42 > chemicalElement 1`] = `
 }
 `;
 
+exports[`science > 42 > notation 1`] = `
+{
+  "name": "pressure",
+  "symbol": "P",
+}
+`;
+
 exports[`science > 42 > unit 1`] = `
 {
   "name": "pascal",
@@ -23,6 +30,13 @@ exports[`science > 1211 > chemicalElement 1`] = `
 }
 `;
 
+exports[`science > 1211 > notation 1`] = `
+{
+  "name": "mass",
+  "symbol": "m",
+}
+`;
+
 exports[`science > 1211 > unit 1`] = `
 {
   "name": "henry",
@@ -38,6 +52,13 @@ exports[`science > 1337 > chemicalElement 1`] = `
 }
 `;
 
+exports[`science > 1337 > notation 1`] = `
+{
+  "name": "friction force",
+  "symbol": "f",
+}
+`;
+
 exports[`science > 1337 > unit 1`] = `
 {
   "name": "radian",

test/modules/science.spec.ts

@@ -7,7 +7,7 @@ const NON_SEEDED_BASED_RUN = 5;
 
 describe('science', () => {
   seededTests(faker, 'science', (t) => {
-    t.itEach('chemicalElement', 'unit');
+    t.itEach('chemicalElement', 'unit', 'notation');
   });
 
   // Create and log-back the seed for debug purposes