# the-big-username-blacklist

> This is a opinionated blacklist of words that you might not like to see used as usernames in your service.

Latest version **1.5.2** (published 2018-12-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install the-big-username-blacklist
pnpm add the-big-username-blacklist
yarn add the-big-username-blacklist
bun add the-big-username-blacklist
```

## 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 | 1.5.2 |
| Published | 2018-12-09 |
| First published | 2015-08-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 92.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 20 |
| Author | Martin Sandström |
| Maintainers | marteinn |
| Keywords | username, blacklist |

## Links

- npm: https://www.npmjs.com/package/the-big-username-blacklist
- Repository: https://github.com/marteinn/The-Big-Username-Blacklist-JS
- Issues: https://github.com/marteinn/The-Big-Username-Blacklist-JS/issues
- npm.io page: https://npm.io/package/the-big-username-blacklist

## Recent versions

- 1.5.2 (latest) — 2018-12-09
- 1.5.1 — 2017-04-16
- 1.5.0 — 2017-04-16
- 1.4.0 — 2017-01-01
- 1.3.4 — 2016-11-13
- 1.3.3 — 2016-11-13
- 1.3.2 — 2016-11-13
- 1.3.1 — 2016-03-12
- 1.3.0 — 2016-01-06
- 1.2.0 — 2015-12-06
- 1.1.0 — 2015-11-28
- 1.0.1 — 2015-08-27
- 1.0.0 — 2015-08-27

## README

[![Build Status](https://travis-ci.org/marteinn/The-Big-Username-Blacklist-JS.svg?branch=master)](https://travis-ci.org/marteinn/the-big-username-blacklist-js)
[![npm version](https://badge.fury.io/js/the-big-username-blacklist.svg)](https://badge.fury.io/js/the-big-username-blacklist)

# The-Big-Username-Blacklist-JS

This library lets you validate usernames against a blacklist. The blacklist data is based on the data from [The-Big-Username-Blacklist](https://github.com/marteinn/The-Big-Username-Blacklist) and contains privilege, programming terms, section names, financial terms and actions.

You can try the blacklist using the tool [Username checker](http://marteinn.github.io/The-Big-Username-Blacklist-JS/).


## How it works

the-big-username-blacklist exposes a function named `validate`, you can use that function to see if a word is occuring in the blacklist.


## Usage

Validating a username is easy, if the word is in the blacklist, return False (validation failed), otherwise True. Example:

```javascript
>>>> var blacklist = require("the-big-username-blacklist");
>>>> blacklist.validate("martin");
true
>>>> blacklist.validate("root");
false
```


The same would be written like this in ES6.

```javascript
>>>> import blacklist from "the-big-username-blacklist";
>>>> blacklist.validate("martin");
true
>>>> blacklist.validate("root");
false
```

#### Access the blacklist

If you only want to retrive the blacklist data, you can find it in the `list` property.

```javascript
>>>> var blacklist = require("the-big-username-blacklist");
>>>> console.log(blacklist.list);
[ '400',
  '401',
  '403'...
```

The same would be written like this in ES6.

```javascript
>>>> import {list} from "the-big-username-blacklist";
>>>> console.log(list);
[ '400',
  '401',
  '403'...
```


## Installation

This package is available through npm

    $ npm install the-big-username-blacklist


We also include a minified version that you can put on your cdn:

- [Development Version](https://raw.githubusercontent.com/marteinn/The-Big-Username-Blacklist-JS/develop/dist/the-big-username-blacklist.min.js)
- [Production Version](https://raw.githubusercontent.com/marteinn/The-Big-Username-Blacklist-JS/master/dist/the-big-username-blacklist.min.js)


## Tests

It's simple, just run:

    npm run test


## Contributing

Want to contribute? Awesome. Just send a pull request.

All code are in es6 format and can be found in the `src` directory, to compile back to es5 type: `npm run build`


## License

The-Big-Username-Blacklist is released under the [MIT License](http://www.opensource.org/licenses/MIT).

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