kitsu

Kitsu

Promise based NodeJS API wrapper for Kitsu.io

Features

• Supports OAuth2 authentication
• Supports the JSON API specification
• Supports the Promise API
• Retries on network failure
• Timeout handling

Install

yarn add kitsu

or

npm install kitsu --save

Usage

// ES6+
import Kitsu from 'kitsu'
// CommonJS
const Kitsu = require('kitsu').default

const kitsu = new Kitsu()

kitsu.get('anime').then(res => console.log(res))

More Examples

Docs

kitsu.get(model, [options])

Returns a Promise of a response object

model

Type: string

The resource model to request. Check out the Kitsu API documentation for available models

options

Type: object

Any of the JSON API request parameters

include

Type: string

Include relationships. Multiple includes are comma seperated

fields

Type: object

Returns only the specified fields

sort

Type: string

Sort lists by an attribute. Append - for descending order. Multiple sorts are comma seperated

page

Type: object

Limit number of returned resources (page: { limit: 2 }).

Offset returned resources (page: { offset: 20 })

filter

Type: object

Filter returned resources by an attribute

Contributing

Requirements

• git 2.0.0 or newer
• node.js 7.0.0 or newer
• yarn 0.21.0 or newer (optional)

Setup

1. Fork this repo

2. Clone your fork:

   git clone https://github.com/your-username/kitsu.git
   cd kitsu
   

3. Create a feature branch:

   git checkout -b your-feature-name
   

4. Install dependencies:

   yarn install
   # or
   npm install
   

5. Commit changes:

   git commit -am 'feat: add feature name'
   

6. Push changes:

   git push origin your-feature-name
   

7. Open a pull request

Releases

See CHANGELOG

License

All code released under MIT