gender-detection-from-name - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

index.js

@@ -10,3 +10,3 @@ const enMap = require('./names/en')
  */
-function genderFromName (name, lang = 'all') {
+function getGender (name, lang = 'all') {
   if (!name) {
@@ -30,2 +30,2 @@ return 'unknown'
 
-exports.genderFromName = genderFromName
+exports.getGender = getGender

package.json

 {
   "name": "gender-detection-from-name",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Gender detection from first name",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 # Gender detection from name
 This simple project detects the gender of a first name. An optional language parameter can be specified to improve the detection, for example: Andrea in EN is female, in IT is male. If no language is specified, EN has priority.
 
+### Example
+```js
+const { getGender } = require('gender-detection-from-name')
+
+function main() {
+  const genderEN = getGender('Andrea', 'en')
+  const genderIT = getGender('Andrea', 'it')
+  const gender = getGender('Jennifer')
+  console.log(genderEN) // female
+  console.log(genderIT) // male
+  console.log(gender) // female
+}
+```
+
 ### Run tests
 - `npm test`
+
+### Run lint
+- `npm run lint`

test/test.js

 const assert = require('assert')
-const genderDetection = require('../index')
+const { getGender } = require('../index')
 
@@ -8,3 +8,3 @@ describe('Tests for Gender detection from name', () => {
     for (let name of names) {
-      assert.strictEqual(genderDetection(name, 'en'), 'male')
+      assert.strictEqual(getGender(name, 'en'), 'male')
     }
@@ -15,3 +15,3 @@ })
     for (let name of names) {
-      assert.strictEqual(genderDetection(name, 'en'), 'female')
+      assert.strictEqual(getGender(name, 'en'), 'female')
     }
@@ -22,3 +22,3 @@ })
     for (let name of names) {
-      assert.strictEqual(genderDetection(name, 'it'), 'male')
+      assert.strictEqual(getGender(name, 'it'), 'male')
     }
@@ -29,3 +29,3 @@ })
     for (let name of names) {
-      assert.strictEqual(genderDetection(name, 'it'), 'female')
+      assert.strictEqual(getGender(name, 'it'), 'female')
     }
@@ -36,3 +36,3 @@ })
     for (let name of names) {
-      assert.strictEqual(genderDetection(name), 'male')
+      assert.strictEqual(getGender(name), 'male')
     }
@@ -43,3 +43,3 @@ })
     for (let name of names) {
-      assert.strictEqual(genderDetection(name), 'female')
+      assert.strictEqual(getGender(name), 'female')
     }
@@ -50,3 +50,3 @@ })
     for (let name of names) {
-      assert.strictEqual(genderDetection(name), 'unknown')
+      assert.strictEqual(getGender(name), 'unknown')
     }
@@ -57,5 +57,5 @@ })
     for (let name of names) {
-      assert.strictEqual(genderDetection(name), 'unknown')
+      assert.strictEqual(getGender(name), 'unknown')
     }
   })
 })

No alert changes

Improved metrics

Total package byte prevSize

863464

increased by0.03%

Number of lines in readme file

23

increased by283.33%

No dependency changes