# haikunator

> Generate Heroku-like random names to use in your node applications.

Latest version **2.1.2** (published 2019-12-01) · BSD-3-Clause license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.2 |
| Published | 2019-12-01 |
| First published | 2015-03-17 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 52.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 269 |
| Maintainers | atrox |
| Keywords | generator, haikunate, haikunator, heroku, heroku-like, names, random |

## Links

- npm: https://www.npmjs.com/package/haikunator
- Repository: https://github.com/Atrox/haikunatorjs
- Issues: https://github.com/Atrox/haikunatorjs/issues
- npm.io page: https://npm.io/package/haikunator

## Dependencies (3)

- [random-seed](https://npm.io/package/random-seed.md) ^0.3.0
- [lodash.defaults](https://npm.io/package/lodash.defaults.md) ^4.2.0
- [@types/random-seed](https://npm.io/package/@types/random-seed.md) ^0.3.3

## Recent versions

- 2.1.2 (latest) — 2019-12-01
- 2.0.0-beta.1 (beta) — 2016-09-02
- 2.1.1 — 2019-03-28
- 2.1.0 — 2019-03-26
- 2.0.0 — 2016-09-24
- 1.2.3 — 2016-05-25
- 1.2.1 — 2016-05-10
- 1.2.0 — 2016-05-03
- 1.1.0 — 2015-12-23
- 1.0.2 — 2015-12-10
- 1.0.1 — 2015-09-26
- 1.0.0 — 2015-09-26
- 0.2.2 — 2015-03-21
- 0.2.1 — 2015-03-20
- 0.2.0 — 2015-03-19
- … 2 more at https://npm.io/package/haikunator/versions

## README

# HaikunatorJS

[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fatrox%2Fhaikunatorjs%2Fbadge&style=flat-square)](https://actions-badge.atrox.dev/atrox/haikunatorjs/goto)
[![Latest Version](https://img.shields.io/npm/v/haikunator.svg?style=flat-square)](https://www.npmjs.com/package/haikunator)
[![Dependency Status](https://img.shields.io/david/atrox/haikunatorjs.svg?style=flat-square)](https://david-dm.org/atrox/haikunatorjs)
[![devDependency Status](https://img.shields.io/david/dev/atrox/haikunatorjs.svg?style=flat-square)](https://david-dm.org/atrox/haikunatorjs#info=devDependencies)
[![Coverage Status](https://img.shields.io/codecov/c/github/Atrox/haikunatorjs.svg?style=flat-square)](https://codecov.io/gh/Atrox/haikunatorjs)

Generate Heroku-like random names to use in your node applications.

## Installation

```
npm install --save haikunator
```

## Usage

Haikunator is pretty simple.

```javascript
var Haikunator = require('haikunator')
// ES6: import Haikunator from 'haikunator'

// Instantiate Haikunator without options
// var haikunator = new Haikunator()

// Instantiate Haikunator with default options
var haikunator = new Haikunator({
    adjectives: ['custom', 'adjectives'],
    nouns: ['custom', 'nouns'],
    seed: 'custom-seed',
    defaults: { // class defaults
        tokenLength: 8,
        tokenChars: 'HAIKUNATOR',
        // ...
    }
})

// default usage
haikunator.haikunate() // => "wispy-dust-1337"

// custom length (default=4)
haikunator.haikunate({tokenLength: 6}) // => "patient-king-887265"

// use hex instead of numbers
haikunator.haikunate({tokenHex: true}) // => "purple-breeze-98e1"

// use custom chars instead of numbers/hex
haikunator.haikunate({tokenChars: "HAIKUNATE"}) // => "summer-atom-IHEA"

// don't include a token
haikunator.haikunate({tokenLength: 0}) // => "cold-wildflower"

// use a different delimiter
haikunator.haikunate({delimiter: "."}) // => "restless.sea.7976"

// no token, space delimiter
haikunator.haikunate({tokenLength: 0, delimiter: " "}) // => "delicate haze"

// no token, empty delimiter
haikunator.haikunate({tokenLength: 0, delimiter: ""}) // => "billowingleaf"
```

## Options

The following options are available:

```javascript
var Haikunator = require("haikunator")

var haikunator = new Haikunator({
    adjectives: ['custom', 'adjectives'],
    nouns: ['custom', 'nouns'],
    seed: 'custom-seed', // Custom seed
    defaults: { // Class wide defaults, can get overridden by haikunate(options)
        delimiter: "-",
        tokenLength: 4,
        tokenHex: false,
        tokenChars: "0123456789",
    }
})

// Same options are also available on the haikunate method
haikunator.haikunate({
    delimiter: "-",
    tokenLength: 4,
    tokenHex: false,
    tokenChars: "0123456789"
})
```
*If ```tokenHex``` is true, any tokens specified in ```tokenChars``` are ignored*

## Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help:

- [Report bugs](https://github.com/atrox/haikunatorjs/issues)
- Fix bugs and [submit pull requests](https://github.com/atrox/haikunatorjs/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features

## Other Languages

Haikunator is also available in other languages. Check them out:

- .NET: https://github.com/Atrox/haikunator.net
- Python: https://github.com/Atrox/haikunatorpy
- PHP: https://github.com/Atrox/haikunatorphp
- Java: https://github.com/Atrox/haikunatorjava
- Go: https://github.com/Atrox/haikunatorgo
- Perl: https://github.com/Atrox/haikunatorperl
- Dart: https://github.com/Atrox/haikunatordart
- Ruby: https://github.com/usmanbashir/haikunator
- Rust: https://github.com/nishanths/rust-haikunator

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