https://github.com/murshidazher/snake-names
🐍 Get popular snake names
https://github.com/murshidazher/snake-names
array names npm npm-package random random-names snake
Last synced: about 2 months ago
JSON representation
🐍 Get popular snake names
- Host: GitHub
- URL: https://github.com/murshidazher/snake-names
- Owner: murshidazher
- License: mit
- Created: 2020-12-09T14:46:20.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-04-04T21:37:30.000Z (2 months ago)
- Last Synced: 2025-04-04T22:28:57.835Z (2 months ago)
- Topics: array, names, npm, npm-package, random, random-names, snake
- Language: JavaScript
- Homepage: https://npm.im/snake-names
- Size: 290 KB
- Stars: 3
- Watchers: 2
- Forks: 18
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# [snake-names](https://github.com/murshidazher/snake-names) [](https://github.com/murshidazher/snake-names/releases/latest)
[](https://travis-ci.com/)
[](https://codecov.io/gh/murshidazher/snake-names)
> Get popular snake names. Certified Lit 🔥🔥 **Accepting PRs for additional names.**
- An npm package to return a list of popular snake names.
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Installing / Getting started](#installing--getting-started)
- [Usage](#usage)
- [CLI](#cli)
- [API](#api)
- [Contributors](#contributors)
- [License](#license)
## Installing / Getting started
A quick introduction of the minimal setup you need to get a up & running.
```shell
$ npm install snake-names
```
OR
```shell
$ yarn add snake-names
```
## Usage
Here's a brief intro about what a developer must do in order to start developing the project further:
**ES5**:
```js
const snakeNames = require('snake-names');
snakeNames.random();
//=> 'Albert'
```
**React or ES6**:
```js
import snakeNames from "snake-names";
snakeNames.random();
//=> 'Albert'
```
## CLI
```shell
$ npm install --global snake-names
```
OR
```shell
$ yarn global add snake-names
```
```shell
$ snake-names --help
Get popular snake names
Usage
$ snake-names
Options
--all Get all the names instead of a random name
--type Type of name [Default: all] [Values: female, male, all]
Examples
$ snake-names
Albert
$ snake-names --all --type male
Adrian
Igor
…
```
## API
| Method | Type | Description |
| :----------: | :----------: | --------------------------------------------------------------------------------------------------------------------- |
| `.all` | array | List all popular snake names |
| `.male` | array | List all popular male snake names |
| `.female` | array | List all popular female snake names |
| `.cute` | array | List all cute snake names |
| `.unique` | array | List all unique snake names |
| `.famous` | array | List all famous snake names |
| `.random(n)` | string/array | returns a random snake name if no param is provided. Otherwise, returns an array of random snake names of length `n`. |
## Contributors
[](https://github.com/murshidazher/snake-names/graphs/contributors)
## License
[MIT](https://github.com/murshidazher/snake-names/blob/master/LICENSE) © Murshid Azher.