From 46e43f4bde4a35785b4997b81e86cd19f046b69b Mon Sep 17 00:00:00 2001 From: Minteck Date: Tue, 21 Dec 2021 16:52:28 +0100 Subject: Commit --- src/node_modules/chance/docs/helpers/set.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 src/node_modules/chance/docs/helpers/set.md (limited to 'src/node_modules/chance/docs/helpers/set.md') diff --git a/src/node_modules/chance/docs/helpers/set.md b/src/node_modules/chance/docs/helpers/set.md new file mode 100644 index 0000000..da0293f --- /dev/null +++ b/src/node_modules/chance/docs/helpers/set.md @@ -0,0 +1,23 @@ +# set + +```js +// usage +chance.set(key, value) +``` + +Used for overriding the default data used by Chance. + +For example, if instead of the default set of last names (which were pulled from the U.S. census data and therefore obviously American biased), you could replace the data for the first names with something more suited to your task. For example, if you want instead to pick from last names of houses in *A Song of Ice and Fire*, you could do something like: + +```js +chance.set('lastNames', ['Arryn', 'Baratheon', 'Bolton', 'Frey', 'Greyjoy', 'Lannister', 'Martell', 'Stark', 'Targaryen', 'Tully', 'Tyrell']); + +// then +chance.last() +=> 'Lannister' +``` + +This is very handy for internationalization. + +Available keys for datasets to override: `firstNames`, `lastNames`, `provinces`, `us_states_and_dc`, `territories`, `armed_forces`, `street_suffixes`, `months`, `cc_types`, `currency_types` + -- cgit