https://github.com/flet/room-names
:house: List of room names curated from Wikipedia
https://github.com/flet/room-names
Last synced: 3 months ago
JSON representation
:house: List of room names curated from Wikipedia
- Host: GitHub
- URL: https://github.com/flet/room-names
- Owner: Flet
- License: mit
- Created: 2018-01-26T22:18:46.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-01-26T22:18:58.000Z (over 7 years ago)
- Last Synced: 2025-02-24T16:17:38.697Z (4 months ago)
- Language: JavaScript
- Size: 4.88 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# room-names
A list of rooms curated from Wikipedia.
## Install
```sh
npm install room-names [--g|--save]
```
## Example
```js
var room = require('room-names')
// random character
console.log(room())
//=> 'Sunroom'
// all rooms
console.log(room.rooms)
//=> ["Aerary","Air shower", ..., "Wiring closet", "Workshop"]
```
## Usage
[](https://www.npmjs.com/package/room-names)
### 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:
```sh
$ room-names
Frigidarium
```
## See Also
- [marvel-characters](https://github.com/mattdesl/marvel-characters)
## License
MIT, see [LICENSE.md](http://github.com/flet/room-names/blob/master/LICENSE.md) for details.