# randomizeusername

> Very simple random username generator

Latest version **0.0.3** (published 2018-08-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install randomizeusername
pnpm add randomizeusername
yarn add randomizeusername
bun add randomizeusername
```

## 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.3 |
| Published | 2018-08-31 |
| First published | 2018-08-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 121.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Halil Irmak |
| Maintainers | cryptopickle |

## Links

- npm: https://www.npmjs.com/package/randomizeusername
- Repository: https://github.com/cryptoPickle/randomizeusername
- Homepage: https://github.com/cryptoPickle/randomizeusername#readme
- Issues: https://github.com/cryptoPickle/randomizeusername/issues
- npm.io page: https://npm.io/package/randomizeusername

## Dependencies (8)

- [jest](https://npm.io/package/jest.md) ^23.5.0
- [superb](https://npm.io/package/superb.md) ^3.0.0
- [pokemon](https://npm.io/package/pokemon.md) ^1.2.3
- [slugify](https://npm.io/package/slugify.md) ^1.3.1
- [cat-names](https://npm.io/package/cat-names.md) ^1.0.2
- [dog-names](https://npm.io/package/dog-names.md) ^1.0.2
- [superheroes](https://npm.io/package/superheroes.md) ^2.0.0
- [randomizeusername](https://npm.io/package/randomizeusername.md) ^0.0.1

## Recent versions

- 0.0.3 (latest) — 2018-08-31
- 0.0.2 — 2018-08-31
- 0.0.1 — 2018-08-31

## README

[![Build Status](https://travis-ci.org/cryptoPickle/randomizeusername.svg?branch=build)](https://travis-ci.org/cryptoPickle/randomizeusername)


# Random UserName Generator

This simple library can help you to create random cool usernames.


### Usage
Usage is as simple as the bellow;
```
  randomUserName() // ['flawless_Ace']
```

### Options



| Param  | what is it for |
| ------------- | ------------- |
| `slug`  | Lets you add custom slugs, accepts an Array, and randomize them  |
| `extra`  | You can provide an array of custom cool usernames  |
|`position`| default to `beggining`, which adds provided username begging of the random username, `end` is adding it end of the string. `random` is randomizing position |
|`count`| Accepts integer, you can specify how many usernames you want to get. Returns an Array of usernames |


#### Basic Usage
```
randomUserName({
  slug: ['_', '+'],
  extra: ['rick','morty'],
  count: 10,
  position: 'random'
}) 
```
returns 
```
​​​​​[ 'kickass+Angel-rick',​​​​​
​​​​​  'rick-polished+Patches',​​​​​
​​​​​  'morty-ace+Cuddles',​​​​​
​​​​​  'superior+Felix-morty',​​​​​
​​​​​  'rick-primo+Simon',​​​​​
​​​​​  'morty-super+Tiger',​​​​​
​​​​​  'morty-tremendous+Jasmine',​​​​​
​​​​​  'stunning+Whiskers-rick',​​​​​
​​​​​  'rick-spectacular+Annie',​​​​​
​​​​​  'morty-doozie+Zoe' ]​​​​​
```

:))

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