snake-names

Get popular snake names

Usage no npm install needed!

<script type="module">
  import snakeNames from 'https://cdn.skypack.dev/snake-names';
</script>

README

snake-names npm

travisci codecov code style: prettier

Get popular snake names. Certified Lit 🔥🔥 Accepting PRs for additional names.

  • A npm package to return a list of popular snake names.

Table of Contents

Installing / Getting started

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

$ npm install snake-names

Usage

Here's a brief intro about what a developer must do in order to start developing the project further:

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

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

CLI

$ npm install --global 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

contributors

License

MIT © Murshid Azher.