56 lines
1.3 KiB
Markdown
56 lines
1.3 KiB
Markdown
|
# superheroes
|
||
|
|
|
||
|
|
> Get superhero names
|
||
|
|
|
||
|
|
<img src="https://cloud.githubusercontent.com/assets/170270/7563453/ad57a684-f7dd-11e4-8302-081f132e8653.png" width="100" height="112" align="right">
|
||
|
|
|
||
|
|
The list is just a [JSON file](superheroes.json) and can be used anywhere.
|
||
|
|
|
||
|
|
**I'm not accepting additional entries to the list.**
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
```sh
|
||
|
|
npm install superheroes
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
import superheroes from 'superheroes';
|
||
|
|
|
||
|
|
superheroes;
|
||
|
|
//=> ['3-D Man', 'A-Bomb', …]
|
||
|
|
```
|
||
|
|
|
||
|
|
## API
|
||
|
|
|
||
|
|
### superheroes
|
||
|
|
|
||
|
|
Type: `string[]`
|
||
|
|
|
||
|
|
Superhero names in alphabetical order.
|
||
|
|
|
||
|
|
### randomSuperhero()
|
||
|
|
|
||
|
|
Type: `Function`
|
||
|
|
|
||
|
|
Get a random superhero name.
|
||
|
|
|
||
|
|
```js
|
||
|
|
import {randomSuperhero} from 'superheroes';
|
||
|
|
|
||
|
|
randomSuperhero();
|
||
|
|
//=> 'Spider-Ham'
|
||
|
|
```
|
||
|
|
|
||
|
|
## Related
|
||
|
|
|
||
|
|
- [superheroes-cli](https://github.com/sindresorhus/superheroes-cli) - CLI for this module
|
||
|
|
- [supervillains](https://github.com/sindresorhus/supervillains) - Get supervillain names
|
||
|
|
- [cat-names](https://github.com/sindresorhus/cat-names) - Get popular cat names
|
||
|
|
- [dog-names](https://github.com/sindresorhus/dog-names) - Get popular dog names
|
||
|
|
- [pokemon](https://github.com/sindresorhus/pokemon) - Get Pokémon names
|
||
|
|
- [superb](https://github.com/sindresorhus/superb) - Get superb like words
|
||
|
|
- [yes-no-words](https://github.com/sindresorhus/yes-no-words) - Get yes/no like words
|