room-names v1.0.0

room-names

A list of rooms curated from Wikipedia.

Install

npm install room-names [--g|--save]

Example

var room = require('room-names')

// random character
console.log(room())
//=> 'Sunroom'

// all rooms
console.log(room.rooms)
//=> ["Aerary","Air shower", ..., "Wiring closet", "Workshop"]

Usage

API

name = room()

Returns a random room name, like "Attic".

list = room.rooms

The array of all room names.

list = require('room-names/rooms.json')

The required JSON array.

CLI

You can also use the CLI here.

Usage:
  room-names [opt]

Options:
  --help  show help
  --all   list all rooms

Example:

$ room-names
Frigidarium

See Also

• marvel-characters

License

MIT, see LICENSE.md for details.