Real-name NPM | npm.io

real-name

A lightweight utility that checks if a string matches any name that has been used in the United States from 1880 to 2008, based on Social Security Administration data.

This also works for names from other countries. Check out the full dataset here to see for yourself.

Installation

npm install real-name

Usage

Check if a string is a name

import isName from 'real-name';

// Basic name checking
console.log(isName('John')); // true
console.log(isName('Fruitcake')); // false

// Works with first names only
console.log(isName('John Smith')); // false
console.log(isName('John')); // true

// Case-insensitive
console.log(isName('john')); // true
console.log(isName('John')); // true
console.log(isName('JOHN')); // true

Combine with `word-exists`

// Optional accessory to combine with isName
// Not my package, need to install it separately
// And update it to use ESM syntax
import wordExists from 'word-exists';

// Stricter filtering by combining with word-exists
function isValidName(str) {
    return isName(str) && !wordExists(str);
}

// Not always that reliable
console.log(isValidName('Adam')); // true (it's a name, not a word)
console.log(isValidName('Dick')); // false (It means penis FYI)
console.log(isValidName('John')); // false (This means bathroom I guess?)
console.log(isValidName('Jane')); // false (Okay what the fuck)
console.log(isValidName('Tom')); // false (...? I guess don't try this)

Extract names from an email address

import isName from 'real-name';

function extractNameFromEmail(email) {
    // Get the part before the @ symbol and take only the first segment
    const firstName = email.split('@')[0].split(/[._-]/)[0];
    return isName(firstName) ? firstName[0].toUpperCase() + firstName.slice(1) : null;
}

// Example usage
console.log(extractNameFromEmail('john.doe@example.com')); // 'John'
console.log(extractNameFromEmail('jane_doe-123@example.com')); // 'Jane'
console.log(extractNameFromEmail('jim.bob@example.com')); // 'Jim'
console.log(extractNameFromEmail('jeff@example.com')); // 'Jeff'
console.log(extractNameFromEmail('hello@example.com')); // null