Registry / productivity / email-formatter

email-formatter

library1.0.5jsnpmunverified

A minimal library for formatting email addresses specifically for Gmail/Googlemail domains. Current stable version 1.0.5, low release cadence. Differentiators: simple regex-based transformation that removes dots from Gmail usernames and normalizes to lowercase. Limited scope and no active development since 2021.

productivity

npm install email-formatter

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · EMAIL-FORMATTER

email-formatter

productivityjavascriptv1.0.5

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

emailFormatter

✓ const emailFormatter = require('email-formatter');

✗ import emailFormatter from 'email-formatter';

This package uses CommonJS; ESM import may fail without a default export wrapper.

emailFormatter

✓ import emailFormatter = require('email-formatter');

✗ import { emailFormatter } from 'email-formatter';

TypeScript users should use import = require() syntax for CJS modules.

emailFormatter

✓ const emailFormatter = require('email-formatter');

✗ const { emailFormatter } = require('email-formatter');

The module exports a function directly, not an object with a named property.

Shows CommonJS usage with Gmail formatting (dots removed, lowercase) and invalid email handling.

const emailFormatter = require('email-formatter'); const formatted = emailFormatter('Your.email+tag@gmail.com'); console.log(formatted); // 'youremail+tag@gmail.com' const invalid = emailFormatter('not-an-email'); console.log(invalid); // null

Debug

Known issues

gotchaThe library only formats Gmail/Googlemail addresses; other domains are only lowercased.

fix

Use only for Gmail normalization; for general email formatting, consider a more comprehensive library.

affects: all

gotchaEmail validation is very basic—only checks for a basic regex pattern; does not verify deliverability.

fix

Combine with a proper email validation library like validator.js for RFC compliance.

affects: all

gotchaThe library uses CommonJS only; ESM projects require dynamic import or bundler configuration.

fix

Use const emailFormatter = await import('email-formatter'); then call emailFormatter.default(email).

affects: all

Errors

Common errors & fixes

ReferenceError: emailFormatter is not defined

Using the function before importing or incorrect import syntax.

fix

Ensure const emailFormatter = require('email-formatter'); is placed before usage.

TypeError: emailFormatter is not a function

Importing as an object and trying to call it.

fix

Use const emailFormatter = require('email-formatter'); (default export) not { emailFormatter }.

Upgrade

Version history

1.0.5latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

37 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/dngiang2003/email-formatter ↗

packageemail-formatter ↗

homepagehttps://github.com/dngiang2003/email-formatter#readme ↗