# protect-email

> Email addresses characters convertor to HTML entities to protect against spam bots and crawlers

Latest version **0.1.2** (published 2018-05-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install protect-email
pnpm add protect-email
yarn add protect-email
bun add protect-email
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2018-05-22 |
| First published | 2018-05-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Aleksandr Krivoshchekov |
| Maintainers | superpaintman |
| Keywords | protect-email, antispambot |

## Links

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

## 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.1.2 (latest) — 2018-05-22
- 0.1.1 — 2018-05-22
- 0.1.0 — 2018-05-22

## README

# protect-email

[![Linux Build][travis-image]][travis-url]
[![Test Coverage][coveralls-image]][coveralls-url]
[![Commitizen friendly][commitizen-image]][commitizen-url]
[![NPM version][npm-v-image]][npm-url]
[![NPM Downloads][npm-dm-image]][npm-url]


Email addresses characters convertor to HTML entities to protect against spam
bots and crawlers.

A JavaScript port of [Wordpress `antispambot`][wordpress-antispambot-url].


--------------------------------------------------------------------------------


## Installation

```sh
$ npm install --save protect-email
# Or with yarn
$ yarn add protect-email
```


--------------------------------------------------------------------------------


## Usage

```ts
'use strict';
import { protectEmail, protectEmailAlways, protectEmailFactory } from 'protect-email';

const email = 'test.email@gmail.com';

// Depends on random
const encoded = protectEmail(email);
// => "test.email@gmail.com"
// or
// => "test.email@gmail.com"
// or
// => "test.email@gmail.com"
// etc. (It depends on random)


// With hex encoding
const encoded = protectEmail(email, true);
// => "test.email@g%6dail.%63om"
// or
// => "te%73t.%65m%61%69%6c%40%67ma%69l.c%6fm"
// or
// => "te%73t%2ee%6d%61il@gmai%6c%2ec%6fm"
// etc. (It depends on random)


// Idempotent (always encodes)
const encoded = protectEmailAlways(email);
// => "test.email@gmail.com"


// Or you can specify your own randomize function (`Math.random` by default)
let i = 0;
const myProtectEmail = protectEmailFactory(() => i++ % 2 / 2);

const encoded = myProtectEmail(email);
// => "test.email@gmail.com"
```

--------------------------------------------------------------------------------


## Build

```sh
$ npm install
$ # or
$ yarn
$
$ npm run build
```


--------------------------------------------------------------------------------

## Test

```sh
$ npm run test
```


--------------------------------------------------------------------------------

## Contributing

1. Fork it (<https://github.com/SuperPaintman/protect-email/fork>)
2. Create your feature branch (`git checkout -b feature/<feature_name>`)
3. Commit your changes (`git commit -am '<type>(<scope>): added some feature'`)
4. Push to the branch (`git push origin feature/<feature_name>`)
5. Create a new Pull Request


--------------------------------------------------------------------------------

## Contributors

- [SuperPaintman](https://github.com/SuperPaintman) SuperPaintman - creator, maintainer


--------------------------------------------------------------------------------

## Changelog
[Changelog][changelog-url]


--------------------------------------------------------------------------------

## License

[MIT][license-url]


[license-url]: https://raw.githubusercontent.com/SuperPaintman/protect-email/master/LICENSE
[changelog-url]: https://raw.githubusercontent.com/SuperPaintman/protect-email/master/CHANGELOG.md
[npm-url]: https://www.npmjs.com/package/protect-email
[npm-v-image]: https://img.shields.io/npm/v/protect-email.svg
[npm-dm-image]: https://img.shields.io/npm/dm/protect-email.svg
[travis-image]: https://img.shields.io/travis/SuperPaintman/protect-email/master.svg?label=linux
[travis-url]: https://travis-ci.org/SuperPaintman/protect-email
[coveralls-image]: https://img.shields.io/coveralls/SuperPaintman/protect-email/master.svg
[coveralls-url]: https://coveralls.io/r/SuperPaintman/protect-email?branch=master
[commitizen-image]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[commitizen-url]: https://commitizen.github.io/cz-cli/
[wordpress-antispambot-url]: https://core.trac.wordpress.org/browser/tags/4.9.6/src/wp-includes/formatting.php#L2500

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