kitsu

Kitsu

Simple & lightweight JSON-API client for Kitsu.io and other compliant APIs

For breaking changes in 2.0, check the CHANGELOG

Features

• Supports OAuth2 token authentication
• Uses the Promise API
• Retries on network failure
• Timeout handling

Install

yarn add kitsu

npm install kitsu --save

Usage

// ES6/Babel/Webpack
import Kitsu from 'kitsu'
// CommonJS/Browserify
const Kitsu = require('kitsu')

// For kitsu.io developers
const kitsu = new Kitsu()

// For other JSON-API uses
// e.g example.org/api/2
const example = new Kitsu({
  apiUrl: 'https://example.org/api',
  apiVer: 2
})

// Get a collection of resources
kitsu.get('anime').then(res => console.log(res))

// Get a resource
kitsu.get('anime/1')

// Get a resource's relationship
kitsu.get('anime/1/episodes')

// Create a resource
kitsu.post('post', {
  content: 'some content'
})

// Update a resource
kitsu.patch('post', {
  id: '1',
  content: 'new content'
})

// Delete a resource
kitsu.remove('post', 1)

More Examples

Docs

You can find the kitsu package documentation here

Check out the Kitsu.io API documentation for all the available models and their responses and relationships

Contributing

See CONTRIBUTING

Releases

See CHANGELOG

License

All code released under MIT