blob: ef85f299436e0d0048613217e55b01e4ed317b40 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
import type { Faker } from '../..';
/**
* The possible definitions related to elements.
*/
export interface ChemicalElement {
/**
* The symbol for the element (e.g. `'He'`).
*/
symbol: string;
/**
* The name for the element (e.g. `'Cerium'`).
*/
name: string;
/**
* The atomic number for the element (e.g. `52`).
*/
atomicNumber: number;
}
export interface Unit {
/**
* The long version of the unit (e.g. `meter`).
*/
name: string;
/**
* The short version/abbreviation of the element (e.g. `Pa`).
*/
symbol: string;
}
/**
* Module to generate science related entries.
*
* ### Overview
*
* Both methods in this module return objects rather than strings. For example, you can use `faker.science.chemicalElement().name` to pick out the specific property you need.
*/
export class ScienceModule {
constructor(private readonly faker: Faker) {
// Bind `this` so namespaced is working correctly
for (const name of Object.getOwnPropertyNames(
ScienceModule.prototype
) as Array<keyof ScienceModule | 'constructor'>) {
if (name === 'constructor' || typeof this[name] !== 'function') {
continue;
}
this[name] = this[name].bind(this);
}
}
/**
* Returns a random periodic table element.
*
* @example
* faker.science.chemicalElement() // { symbol: 'H', name: 'Hydrogen', atomicNumber: 1 }
* faker.science.chemicalElement() // { symbol: 'Xe', name: 'Xenon', atomicNumber: 54 }
* faker.science.chemicalElement() // { symbol: 'Ce', name: 'Cerium', atomicNumber: 58 }
*
* @since 7.2.0
*/
chemicalElement(): ChemicalElement {
return this.faker.helpers.arrayElement(
this.faker.definitions.science.chemicalElement
);
}
/**
* Returns a random scientific unit.
*
* @example
* faker.science.unit() // { name: 'meter', symbol: 'm' }
* faker.science.unit() // { name: 'second', symbol: 's' }
* faker.science.unit() // { name: 'mole', symbol: 'mol' }
*
* @since 7.2.0
*/
unit(): Unit {
return this.faker.helpers.arrayElement(this.faker.definitions.science.unit);
}
}
|
