Skip to content

Vic-rider/gender-profil-guesser

Repository files navigation

Made by @Vic-rider

gender-profil-guesser, based on https://genderize.io/ it informs about the gender of a name or email according to the probability that it has to be it.

Install

Install using npm install gender-profil-guesser

Usage

To include gender-profil-guesser, require or import it:

in JavaScript

const { GenderGuesser } = require("gender-profil-guesser");

in TypeScript

import { GenderGuesser } from "gender-profil-guesser";

Create an instance of it

const genderGuesser = new GenderGuesser();

You can get the gender from your name or email.

Ex :

// it would return a promise so you have to get it.

genderGuesser.guessGenderOf(name_or_email)
  .then(response => {
    console.log(response);
  })
  .catch(error => {
    console.error(error);
  });

You can check if the one who has this attribute is male or female.

Ex :

// it would return a promise so you have to get it.

genderGuesser.isMale(name)
  .then(response => {
    console.log(response);
  })
  .catch(error => {
    console.error(error);
  });

About

Based on https://genderize.io/ it informs about the gender of a name or email according to the probability that it has to be it.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published