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
  • Installing / Getting started
  • Usage
  • CLI
  • API
  • Contributors
  • License

Installing / Getting started

A quick introduction of the minimal setup you need to get a up & running.

$ npm install snake-names

OR

$ 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:

const snakeNames = require('snake-names');

snakeNames.random();
//=> 'Albert'

React or ES6:

import snakeNames from "snake-names";

snakeNames.random();
//=> 'Albert'

CLI

$ npm install --global snake-names

OR

$ yarn global add snake-names

$ 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

License

MIT © Murshid Azher.