gender-detection-ts v1.1.0

Gender Detection

INFO

This repo is a fork of the original project: https://github.com/davidemiceli/gender-detection

Based on improved dataset: https://archive.ics.uci.edu/dataset/591/gender+by+name

Description

A node.js module to determine a person's gender based on his/her first name.

It works also for many languages other than english, supporting international names, using an own datasource of 40.000 records that can be extended. This module is able to clean the text, detecting gender from dirty or unclear names.

Installation

$ npm install gender-detection-ts

Example

// Require gender detection module
import gender from 'gender-detection-ts';

interface DetectionOptions {
  useProbability?: boolean // if a name is unisex, the one with the higher probability will be evaluated
  useCount?: boolean // same with count
  // mutually exclusive
}

let g;

// Use it to detect the gender:
g = gender.detect('Tim Johnson', options);
// "male"

g = gender.detect('Holly');
// "female"

g = gender.detect('GhJGhgj')
// "unknown"

// It works also with unclean or dirty names:
g = gender.detect('BiLL$...');
// "male"

g = gender.detect('::Jenni♥fer::');
// "female"

// Extract the first name
const first_name = gender.getFirstName('Mario Bros');
// "mario"

Unit tests

npm test