gazelle-client v0.3.0

gazelle-client

Simple, idiomatic access to the API features of Gazelle.

Overview

Gazelle provides a JSON API to registered users. This library aims to maintain coverage of all features within a reasonable timeframe and provide an easy to use and obvious surface.

Installation

npm install gazelle-client

yarn add gazelle-client

Example

const gazelle = require('gazelle-client');

const client = new gazelle.GazelleClient('https://what.cd', 'username', 'password');

(async () => {

  try {
    const data = await client.index();
    console.log(data);
  } catch(error) {
    console.error(error.message);
  } 
})();

Available Methods

• announcements
• artist
• bookmarks
• bookmarks_artists (or bookmarksArtists)
• bookmarks_torrents (or bookmarksTorrents)
• browse
• forum_main (or forumMain)
• forum_viewforum (or forumViewForum)
• forum_viewthread (or forumViewThread)
• inbox
• inbox_inbox (or inboxInbox)
• inbox_sentbox (or inboxSentbox)
• inbox_viewconv (or inboxViewconv)
• index
• notifications
• request
• requests
• similar_artists
• subscriptions
• top10
• top10_tags (or top10Tags)
• top10_torrents (or top10Torrents)
• top10_users (or top10Users)
• torrent
• torrentgroup
• user
• usersearch

License

3-clause BSD. A copy is included with the source.