br-gender
Version:
Package to determine gender by name. Some database doest not have GENDER intel, so it can be very helpful a lib that can predict gender based on a person's first name. Be aware, this lib was built upon Brazilians census. So it will work with Brazilian nam
14 lines (13 loc) • 512 B
TypeScript
import { options } from './@types/types';
/**
* This method takes an name and returns the gender based on CENSO-API.
* The method will evaluate given name to decide if it is either male or female based on brazilian census.
* @param name Given name"
* @param options Set options
* -> percentage: if you want to receive the percentage along the gender
*/
declare function getGenderByName(name: string, opts?: options): Promise<string | {
gender: string;
percentage: number;
}>;
export { getGenderByName };