# @helpdotcom/is

> isDate, isUUID, and isEmail for use with help-gen

Latest version **3.0.5** (published 2018-10-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @helpdotcom/is
pnpm add @helpdotcom/is
yarn add @helpdotcom/is
bun add @helpdotcom/is
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.5 |
| Published | 2018-10-17 |
| First published | 2016-05-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 15.4 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | Evan Lucas |
| Maintainers | armoredsky, chance.eakin.help, commitbot, dspivey, ehjs, esatterwhite, evanlucas, jdgriffith, jesusaochoa, jflook, ligerzero459, pmwebster, robsheely, ryantallmadge, sforic |

## Links

- npm: https://www.npmjs.com/package/@helpdotcom/is
- Repository: https://git.help.com/common-backend/is
- Issues: https://git.help.com/common-backend/is/issues
- npm.io page: https://npm.io/package/@helpdotcom/is

## Dependencies (2)

- [tldjs](https://npm.io/package/tldjs.md) ~1.6.2
- [ip-address](https://npm.io/package/ip-address.md) ~5.8.8

## Recent versions

- 3.0.5 (latest) — 2018-10-17
- 3.0.4 — 2018-02-19
- 3.0.3 — 2018-02-19
- 3.0.2 — 2018-01-27
- 3.0.1 — 2017-05-25
- 3.0.0 — 2017-05-23
- 2.2.1 — 2017-05-17
- 2.2.0 — 2017-04-19
- 2.1.4 — 2017-04-19
- 2.1.3 — 2017-04-17
- 2.1.2 — 2017-03-29
- 2.1.1 — 2017-03-08
- 2.1.0 — 2017-03-02
- 2.0.2 — 2017-02-22
- 2.0.1 — 2017-01-27
- … 10 more at https://npm.io/package/@helpdotcom/is/versions

## README

# is

> isDate, isUUID, and isEmail for use with [`help-gen`][]

## Install

```bash
$ npm install --save @helpdotcom/is
```

## Test

```bash
$ npm test
```

## Usage

```js
'use strict'

const is = require('@helpdotcom/is')
```

### isDate(d)

* `d` [`<String>`][] | [`<Date>`][] ISO formatted date string

Returns `true` if `d` is a valid ISO date string. Otherwise, returns `false`.

### isEmail(s)

* `s` [`<String>`][] The email string

Returns `true` if `s` is a valid email address. Otherwise, returns `false`.

### isEmailAllowName(s)

* `s` [`<String>`][] The email string

Returns `true` if `s` is a valid email address with an optional name.
Otherwise, returns `false`.

The following formats are supported:

* `evan.lucas@help.com`
* `Evan Lucas <evan.lucas@help.com>`
* `"Evan Lucas" <evan.lucas@help.com>`
* `"Help.com, LLC" <info@help.com>`
* `Help.com, LLC <info@help.com>`
* `Jane Doe (maiden name) <jane@doe.com>`

### isUUID(s)

* `s` [`<String>`][] The uuid to test.

Returns `true` if `s` is a valid v4 UUID. Otherwise, returns `false`.

### isUrl(s)

* `s` [`<String>`][] The url to test.

Returns `true` if `s` is a valid URL. Otherwise, returns `false`.

### isIpAllowCIDR(s)

* `s` [`<String>`][] The url to test.

Returns `true` if `s` is a valid ip with CIDR notation. Otherwise, returns `false`.


## Author

Evan Lucas

## License

MIT (See `LICENSE` for more info)

[`<String>`]: https://mdn.io/string
[`<Date>`]: https://mdn.io/date
[`help-gen`]: https://git.help.com/common-backend/help-gen

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