Skip to content
👾 Pokemon version of cowsay with CLI and API.
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Fix missing shebang Nov 28, 2016
tools Initial Commit Nov 28, 2016
.gitignore Initial Commit Nov 28, 2016
README.md Initial Commit Nov 28, 2016
demo.png Initial Commit Nov 28, 2016
package.json 1.0.1 Nov 28, 2016
yarn.lock Initial Commit Nov 28, 2016

README.md

pokemonsay

Pokemon version of cowsay with CLI and API.

Inspired by another pokemonsay and parrotsay-api I created this to quell my obsession with Pokemon and command line greetings. This module includes all Pokemon and forms available on Bulbapedia excluding shinies, a total of 846.

CLI

Random

Simply call pokemonsay to get a random Wild POKEMON appeared! message.

Piping to STDIN

Pipe to pokemonsay to get a random Pokemon with the piped message below it.

API

There are a few methods that are available to utilize pokemonsay in your own app/module!

iChooseYou

  • Argument: Object { number, pokemon, form }
  • Result: Array of Objects [{ number, pokemon, form, say }]

Filter through the database using the available info to get matching Pokemon. The resulting objects in an array will contain the following properties:

  • number: National Dex number (integer).
  • pokemon: The name of the Pokemon.
  • form: The first letter of the form.
    • Example: "A" for Alola Form (Marowak A-form) or "A" for Attack Form (Deoxys A-form)
  • say: The ANSI compatible string meant for console.logging.

random

  • Arguments: Integers min, max
  • Result: Object { number, pokemon, form, say }

Get a random pokemonsay object. An optional min and max argument can be used to get Pokemon from a specific generation (including their alternate forms regardless of generation). The resulting object will contain the following properties:

  • number: National Dex number (integer).
  • pokemon: The name of the Pokemon.
  • form: The first letter of the form.
    • Example: "A" for Alola Form (Marowak A-form) or "A" for Attack Form (Deoxys A-form)
  • say: The ANSI compatible string meant for console.logging.

say

default text (Wild POKEMON appeared!)

  • Arguments: Object { pokemon, form, options }
  • Result: String

Returns a string that shows a box with the message Wild POKEMON appeared! with the specified Pokemon and form. The options property is an object that will override the default settings for boxen.

custom text

  • Arguments: Object { text, options }
  • Result: String

Returns a string that shows a box with the message specified. The options property is an object that will override the default settings for boxen.

You can’t perform that action at this time.