# gender-detection

> Detect the gender of a person using his/her first name.

Latest version **0.1.0** (published 2018-10-26) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install gender-detection
pnpm add gender-detection
yarn add gender-detection
bun add gender-detection
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2018-10-26 |
| First published | 2016-08-04 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 848.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | davidemiceli |
| Maintainers | davidemiceli |
| Keywords | gender, sex |

## Links

- npm: https://www.npmjs.com/package/gender-detection
- Repository: https://github.com/davidemiceli/gender-detection
- Homepage: https://github.com/davidemiceli/gender-detection#readme
- Issues: https://github.com/davidemiceli/gender-detection/issues
- npm.io page: https://npm.io/package/gender-detection

## Recent versions

- 0.1.0 (latest) — 2018-10-26
- 0.0.5 — 2016-08-09
- 0.0.4 — 2016-08-05
- 0.0.3 — 2016-08-05
- 0.0.2 — 2016-08-04
- 0.0.1 — 2016-08-04

## README

# Gender Detection

## 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

## Example
```javascript
// Require gender detection module
const gender = require('gender-detection');

let g;

// Use it to detect the gender:
g = gender.detect('Tim Johnson');
// "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
```shell
npm test
```

---
_Source: https://npm.io/package/gender-detection · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._