Back to packageRELEASE DETAILS

1.0.2

npm

4chan-boards

Get a board's name and type given its short name (eg. `/b/`).

Published29 Jan 2018

Direct dependencies4

Transitive dependenciesNot calculated

README

Current package documentation

4chan-boards

Get a board's name and type given its short name (eg. /b/).

2.0.0 BREAKING CHANGES

Enumerated types are now Symbols, so relying on falsy evaluation will no longer work:

const boards = require('4chan-boards')

if (boards.getType('b')) {
  console.log('This will not print!')
}

Instead, use the provided enumerated types:

if (boards.getType('b') !== boards.INVALID) {
  console.log('This message prints! Yay!')
}

Installation

yarn add 4chan-boards

# OR

npm install --save 4chan-boards

Usage

const boards = require('4chan-boards')

console.log(boards.getName('wsg'))                // Worksafe GIF
console.log(boards.getType('b') === boards.NSFW)  // true

API

Methods

Get information (ie name or type) about a board.

boards.getName(board)
boards.getType(board)

Objects

Objects mapping short names to full names. boards.all contains the mapping for all the boards, boards.sfw contains mapping for only the SFW boards, etc.

boards.all
boards.admin
boards.nsfw
boards.sfw

Enumerated types

boards.getType(board) will return an enumerated type, which has been implemented as a Symbol

boards.ADMIN
boards.NSFW
boards.SFW
boards.INVALID

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 5

Native requirements

4 direct targetsNot calculated transitive count

Package / target	Requirement	Relationship
semantic-release Environment { "local_name": "semantic-release", "alias": false, "peer_metadata": null }	`^12.4.1`	runtime
chai Environment { "local_name": "chai", "alias": false, "peer_metadata": null }	`^4.1.2`	development
mocha Environment { "local_name": "mocha", "alias": false, "peer_metadata": null }	`^5.0.0`	development
travis-deploy-once Environment { "local_name": "travis-deploy-once", "alias": false, "peer_metadata": null }	`^4.3.3`	development
semantic-release Environment { "local_name": "semantic-release", "alias": false, "peer_metadata": null }	`^12.4.1`	development

Distribution files

1 collected

Distribution 1

Source distribution

Source file

Checksums from source

{
  "integrity": "sha512-CXx99Admu3zGIUCQACF2U3edgydhtBP14BRD0lotEXs8YEUp2aogileWciZLiQUPK6Qwo9Vg0/XTPXGA9tVv4g==",
  "shasum": "f4c9ec53665572da74b688e8ca222c24cbb49af0",
  "tarball": "https://registry.npmjs.org/4chan-boards/-/4chan-boards-1.0.2.tgz",
  "signatures": [
    {
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
      "sig": "MEUCIB4uzNoYT/aZwnwHOBwugP6KuZ4r56ccI6qRaqAt3s4TAiEAr6QEmYB0ae+mC4/DLdnif0Z3IPZ0SZ5rV62ZodQiIdo="
    }
  ]
}