Profession 2.0.0

CHANGELOG.md

@@ -1,3 +1,10 @@
+<a name="2.0.0"></a>
+# [2.0.0](https://github.com/faker-javascript/profession) (2022-01-09)
+
+### BREAKING CHANGES
+
+* New function `profession` istead of `fakeProfession`
+
 <a name="1.0.0"></a>
 # [1.0.0](https://github.com/faker-javascript/profession) (2022-01-09)
 * Initial release

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

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;

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",

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');
 });