# random-char

> Return a random character.

Latest version **1.0.4** (published 2016-04-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install random-char
pnpm add random-char
yarn add random-char
bun add random-char
```

## 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.0.4 |
| Published | 2016-04-25 |
| First published | 2016-04-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | bubkoo |
| Maintainers | bubkoo |
| Keywords | char, character, generator, generate, random, randomly, randomize, chance, test, dice, mock |

## Links

- npm: https://www.npmjs.com/package/random-char
- Repository: https://github.com/mock-end/random-char
- Homepage: https://github.com/mock-end/random-char#readme
- Issues: https://github.com/mock-end/random-char/issues
- npm.io page: https://npm.io/package/random-char

## Dependencies (4)

- [is-nil](https://npm.io/package/is-nil.md) ^1.0.1
- [to-str](https://npm.io/package/to-str.md) ^1.0.0
- [is-object](https://npm.io/package/is-object.md) ^1.0.1
- [random-natural](https://npm.io/package/random-natural.md) ^1.0.3

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2016-04-25
- 1.0.3 — 2016-04-23
- 1.0.1 — 2016-04-17
- 1.0.0 — 2016-04-15
- 0.0.0 — 2016-04-03

## README

# random-char
  
> Return a random character.

[![MIT License](https://img.shields.io/badge/license-MIT_License-green.svg?style=flat-square)](https://github.com/mock-end/random-char/blob/master/LICENSE)

[![build:?](https://img.shields.io/travis/mock-end/random-char/master.svg?style=flat-square)](https://travis-ci.org/mock-end/random-char)
[![coverage:?](https://img.shields.io/coveralls/mock-end/random-char/master.svg?style=flat-square)](https://coveralls.io/github/mock-end/random-char)


## Install

```
$ npm install --save random-char 
```

## Usage

> For more use-cases see the [tests](https://github.com/mock-end/random-char/blob/master/test/spec/index.js)


```js
var randomChar = require('random-char');

// API
// - randomChar([poolName]);
// - randomChar([options]);

randomChar();
// => 'k'
```

By default it will return a string with random character from the following pool:

```
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789~!@#$%^&()*_+-={}[]'
```

Optionally specify a pool:

```js
randomChar('alpha'); // or
randomChar({alpha: true});
// => 'm'

randomChar('upper'); // or
randomChar({upper: true});
// => 'Z'

randomChar('lower'); // or
randomChar({lower: true});
// => 'j'

randomChar('number'); // or
randomChar({number: true});
// => '7'

randomChar('symbols'); // or
randomChar({symbols: true});
// => '%'
```

Optionally specify a pool and the character will be generated with characters only from that pool:

```js
randomChar('abcde'); // or
randomChar({pool: 'abcde'});
// => 'c'
```

## Related

- [random-integral](https://github.com/mock-end/random-integral) - Return a random integer.
- [random-natural](https://github.com/mock-end/random-natural) - Return a random natural number.
- [random-decimal](https://github.com/mock-end/random-decimal) - Return a random decimal.
- [random-floating](https://github.com/mock-end/random-floating) - Return a random floating point number.
- [random-index](https://github.com/mock-end/random-index) - Return a random array-like index.
- [random-binary](https://github.com/mock-end/random-binary) - Return a random binary number.
- [random-octal](https://github.com/mock-end/random-octal) - Return a random octal number.
- [random-hexadecimal](https://github.com/mock-end/random-hexadecimal) - Return a random hexadecimal number.
- [random-unicode](https://github.com/mock-end/random-unicode) - Return a random unicode. 
- [random-bool](https://github.com/mock-end/random-bool) - Return a random boolean (true/false).


## Contributing

Pull requests and stars are highly welcome.

For bugs and feature requests, please [create an issue](https://github.com/mock-end/random-char/issues/new).

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