npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@teachable/email-validator

v1.0.1

Published

A client side validator for email addresses.

Downloads

3

Readme

Email Validator

Email Validator is a client side validator for email addresses. It currently takes in an email address and an optional error message and checks to see whether or not the email looks valid. Email Validator does not do any form of Regex, MX, or SMPT check. It only checks to see if an email looks correct based upon the Mailcheck library.

Installation

To install Email Validator use yarn or request it via a script tag in the browser:

Script

<script src="https://unpkg.com/@teachable/[email protected]/build/legacy-browser-bundle.js"></script>

The script tag will fetch version 1.0.1 of Email Validator. When loaded with a script tag, EmailValidator is made available on the window.

Yarn

yarn add @teachable/email-validator

Once added, you can access the EmailValidator with:

import { EmailValidator } from '@teachable/email-validator';

Checking for a suggestion

To see if an email looks valid, use checkForSuggestion.

EmailValidator.checkForSuggestion('[email protected]')

The method returns an object, indicating whether or not the email looks valid. For emails that look invalid, the methods returns an object containing:

{
  suggestion: true,
  error: "Did you mean [email protected]?",
  errorWithButton: "Did you mean <button>[email protected]</button>?",
  suggestedEmail: "[email protected]"
}

For valid emails or emails with no suggestions, the method returns an object containing:

{ suggestion: false, error: "", errorWithButton: "", suggestedEmail: "" }

Custom error messages

By default, if a suggestion exists for the email, the checkForSuggestion method returns Did you mean ${suggestedEmail}? as the error message. If you want a different error message, the method accepts a second argument for a custom error message or an error in a foreign language.

EmailValidator.checkForSuggestion('[email protected]', "Are you sure you didn't mean %{suggested_email}?")
{
  suggestion: true,
  error: "Are you sure you didn't mean [email protected]?",
  errorWithButton: "Are you sure you didn't mean <button>[email protected]</button>?",
  suggestedEmail: "[email protected]"
}

All instances of %{suggested_email} will be replaced with the the email suggestion if the email looks invalid. If the custom error text does not contain %{suggested_email}, then no email will be interpolated.