diff --git a/CHANGELOG.md b/CHANGELOG.md index 5a0d4a9..f9b701f 100755 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ + +# [2.0.0](https://github.com/faker-javascript/profession) (2022-01-09) + +### BREAKING CHANGES + +* New function `profession` istead of `fakeProfession` + # [1.0.0](https://github.com/faker-javascript/profession) (2022-01-09) * Initial release diff --git a/README.md b/README.md index 490229f..a774ae9 100644 --- a/README.md +++ b/README.md @@ -15,19 +15,19 @@ $ npm install --save @fakerjs/profession ## Usage ```js -import fakeProfession from '@fakerjs/profession'; +import profession from '@fakerjs/profession'; -fakeProfession(); +profession(); //=> Software Engineer -fakeProfession({rank: true}); +profession({rank: true}); //=> Lead Software Engineer -fakeProfession({rank: true, locale: 'en_US'}); +profession({rank: true, locale: 'en_US'}); //=> Lead Software Engineer -// Allowed ranks: true, false -// Allowed locales: en_US +// Allowed rank: true, false +// Allowed locale: en_US ``` ## Tests diff --git a/index.js b/index.js index b2fbcd8..f947624 100644 --- a/index.js +++ b/index.js @@ -1,4 +1,4 @@ -export default function fakeProfession(options) { +export default function profession(options) { options = options || {}; let ranks = { "en_US": [ @@ -401,7 +401,7 @@ export default function fakeProfession(options) { "Warehouse Manager" ] }; - let locale = ((options.locale === undefined) ? 'en_US' : options.locale); + let locale = options.locale || 'en_US'; let randomProfession = professions[locale][Math.floor(Math.random() * professions[locale].length)]; if (options.rank) { return ranks[locale][Math.floor(Math.random() * ranks[locale].length)] + ' ' + randomProfession; diff --git a/package.json b/package.json index 4b90f1b..02f4cc3 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@fakerjs/profession", - "version": "1.0.0", + "version": "2.0.0", "description": "Profession package provides functionality to generate a fake profession value.", "license": "MIT", "repository": "faker-javascript/profession", @@ -25,6 +25,7 @@ ], "keywords": [ "fakerjs", + "faker", "fake", "random", "profession", diff --git a/test.js b/test.js index d10eab6..29845b2 100644 --- a/test.js +++ b/test.js @@ -1,10 +1,10 @@ -import fakeProfession from './index.js'; +import profession from './index.js'; import test from 'ava'; -test('fakeProfession return type to be string', t => { - t.is(typeof fakeProfession(), 'string'); +test('profession return type to be string', t => { + t.is(typeof profession(), 'string'); }); -test('fakeProfession with rank return type to be string', t => { - t.is(typeof fakeProfession({rank: true}), 'string'); +test('profession with rank return type to be string', t => { + t.is(typeof profession({rank: true}), 'string'); }); \ No newline at end of file