Skip to content

Latest commit

 

History

History
executable file
·
156 lines (105 loc) · 5.15 KB

readme.md

File metadata and controls

executable file
·
156 lines (105 loc) · 5.15 KB
Raw

booru

npm GitHub Typescript typings

English | 中文

A node package to search boorus

Forked from AtoraSuunva/booru

Features

  • Search 20 different boorus (check sites.json)
  • Normalizes all received data into Post objects that are consistent no matter which booru you use
  • Access to the raw data received from the booru as well (transformed from XML to JSON, if applicable)
  • Alias support for boorus (sb for safebooru.org)
  • Promises
  • Types (using Typescript)
  • Choose the amount of images to get
  • Random support for all sites, using order:random on sites that support it and using custom code on those that don't
  • Both browser(without cross-domain) and Node.js support
  • Coming soon(-ish): Support for more than just searching

Installation

npm i @himeka/booru
# or
yarn add @himeka/booru

Usage

const Booru = require('@himeka/booru')

Booru.search('safebooru', ['glaceon'], { limit: 3, random: true }).then(
  posts => {
    for (let post of posts) console.log(post.fileUrl, post.postView)
  },
)

// or (using alias support and creating boorus)
const sb = Booru.forSite('sb')

sb.search(['cat', 'dog'], { limit: 2 })

See example.js for more examples

Docs

Available here: docs

Web support

booru was built for Node.js, and is only officially supported for Node.js. Issues relating to web are fine, although support might be limited.

It's possible to use booru on the web using webpack (or similar), although your experience may vary. Some websites don't have the proper CORS headers, meaning that API requests to those sites from a browser will fail! This is not an issue I can fix in the package, and requires either that booru to add proper support themselves or for you to find a workaround for CORS.

For sites that do not support CORS, there are two solutions as follows

  • Define the global method BOORU_FETCH_PROXY to handle the request URL. Note that the code should be placed before calling Booru.search.
// Replace with your own CORS proxy
globalThis.BOORU_FETCH_PROXY = u => `https://cors.example.com/${u}`
  • Or you can hack it according to the following code. Note that this code should be placed before the reference @himeka/booru.

The CORS proxy in the following example needs to support calls in the form of https://cors.example.com/https://konachan.net/post.json.

const _fetch = window.fetch
const proxy = 'https://cors.example.com/' // Replace with your own CORS proxy
  window.fetch = (input, init) => {
  let url = input.toString()
  if (url.startsWith('https')) { // Handle judgment conditions by yourself
    url = proxy + url // Process it to the format required by the proxy
  }
  return _fetch(url, init)
}

FAQ

What are the properties of a Post?

The basic structure of a Post object looks like:

Post {
  _data: {/*...*/},                       // The raw data from the booru
  fileUrl: 'https://aaaa.com/img.jpg',    // The direct link to the image, ready to post
  id: '124125',                           // The image ID, as a string
  tags: ['cat', 'cute'],                  // The tags, split into an Array
  score: 5,                               // The score as a Number
  source: 'https://ex.com/aaa.png',       // Source of the image, if supplied
  rating: 's',                            // Rating of the image
  createdAt: Date,                        // The `Date` this image was created at
  postView: 'https://booru.ex/show/12345' // A URL to the post
}

s: 'Safe' q: 'Questionable' e: 'Explicit' u: 'Unrated'

Derpibooru has Safe, Suggestive, Questionable, Explicit, although Suggestive will be shown as q in <Post>.rating

Can I contribute?

Sure! Just fork this repo, push your changes, and then make a PR.

I'll accept PR based on what they do and code style (Not super strict about it, but it's best if it roughly follows the rest of the code)

Why?

Why not?

License?

It's MIT

Contributors

BobbyWibowo

Change from request-promise-native to snek-fetch

rubikscraft

Add 2 new boorus (furry.booru.org/realbooru.com) Various Derpibooru fixes

Favna

Add TypeScript declarations Improve TypeScript port Various other small fixes

negezor

Add missing type information