You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Felix Soederhuyzen 77225c2fea chore: updated changelog 3 weeks ago
.gitignore refactor: code style standard 3 weeks ago
CHANGELOG.md chore: updated changelog 3 weeks ago
README.md fix: api change to always return an array 3 weeks ago
genpkmn.js fix: api change to always return an array 3 weeks ago
package-lock.json 1.1.0 1 year ago
package.json v2.0.0 3 weeks ago
yarn.lock chore: added dev dependencies for easier release 3 weeks ago

README.md

js-gen-pkmn

JavaScript Style Guide

This is a port to JavaScript from vardrop/gen-pkmn-name

What is a PKMN?

$ node genpkmn.js
imotaliv

So basically a PKMN is a word created from vocals and konsonants in turn starting with a vocal.

Usage

Cli

$ node genpkmn.js -h
usage: node genpkmn.js [-h] [<NUMBER> <LENGTH> <UNIQUE>]

Generate PKMN names.

positional arguments:
default values can be accessed with 0
  NUMBER                a number of names to be printed                 (default: 1)
  LENGTH                the length of the names to be printed           (default: 8)
  UNIQUE                max repitions of chars (higher, less unique)    (default: 3)

Module

const gen = require('./genpkmn.js')

console.log(gen())

API

gen({number: 0, length: 0, unique: 0})

Input (all params are optional, 0 is for default [1, 8, 3])

Output: Array (i.e. ['afigesev', 'oyuroqeg', 'oqovaluc'])

Takes zero to three parmeters and returns a PKMN with the following specs (default values):

  • 1 PKMN
  • 8 characters
  • Uniquity of 3