# email-valid-simple

> email validation

Latest version **0.0.2** (published 2021-10-30) · ISC license · 0 weekly downloads

## Install

```sh
npm install email-valid-simple
pnpm add email-valid-simple
yarn add email-valid-simple
bun add email-valid-simple
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2021-10-30 |
| First published | 2021-08-31 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 12.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Mark O Grady |
| Maintainers | markogrady1 |
| Keywords | email, emails, validation, rfc822 |

## Links

- npm: https://www.npmjs.com/package/email-valid-simple
- Repository: https://github.com/markogrady1/email-valid-simple
- Homepage: https://github.com/markogrady1/email-valid-simple#readme
- Issues: https://github.com/markogrady1/email-valid-simple/issues
- npm.io page: https://npm.io/package/email-valid-simple

## Dependencies (1)

- [typescript](https://npm.io/package/typescript.md) ^4.3.5

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2021-10-30
- 0.0.1 — 2021-08-31

## README

# email-valid-simple

[![Linux Build][ci-image]][ci-url]
<!-- to be used when/if numbers are respectable[![NPM Version][npm-image]][npm-url] [![NPM Downloads][downloads-image]][downloads-url]-->

package to perform validation on email addresses.

### Installation

```bash
npm install email-valid-simple
```
### Usage

##### Single email validation with `validate()`

simply pass the `validate` function an email string.

```javascript
const email = require('email-valid-simple');

const result = email.validate('föo@domain.com');
console.log(result) // output: true
```

The `validate` function will return a boolean result.

valid email format = true

invalid email format = false

```javascript
const result = email.validate('@domain.com');
console.log(result) // output: false
```

##### Bulk validation with `validateAll()`

perform bulk validation on an array of emails.
The `validateAll` function will return an object containing two arrays, valid and invalid.

```javascript
const emailArr = ['föo@domain.com', '@domain.com'];

const result = email.validateAll(emailArr);
console.log(result);
```
output:

```
{
  valid: [ 'föo@domain.com' ],
  invalid: [ '@domain.com' ]
}
```

### Tests

```javascript
npm run test
```



[ci-image]: https://img.shields.io/github/workflow/status/markogrady1/email-valid-simple/nodejs/master.svg?label=build
[ci-url]: https://github.com/markogrady1/email-valid-simple/actions?query=workflow%3Anodejs
[npm-image]: https://img.shields.io/npm/v/email-valid-simple.svg
[npm-url]: https://npmjs.org/package/email-valid
[downloads-image]: https://img.shields.io/npm/dm/email-valid-simple.svg
[downloads-url]: https://npmcharts.com/compare/email-valid-simple?minimal=true

---
_Source: https://npm.io/package/email-valid-simple · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._