1.0.1 • Published 8 years ago

guessit-wrapper v1.0.1

Weekly downloads
1
License
MIT
Repository
github
Last release
8 years ago

guessit-wrapper

NodeJS wrapper for the http://guessit.io API

Installation

Get the source

run git clone https://github.com/pockata/guessit-wrapper.git

As an npm module

run npm install guessit-wrapper

Usage

The wrapper uses promises from the q library

var guessit = require('guessit-wrapper');

var filename = 'doctor_who_2005.6x03.the_curse_of_the_black_spot.720p_hdtv_x264-fov.mkv';
guessit.parseName(filename).then(function (data) {
        console.log(data);
});

API

guessit.parseName(filename, request_method)

Make a request to the API:

  • filename - The filaname that should be parsed
  • request_method - set to true for POST method. By default GET will be used

guessit.getVersion()

Requests the current API version

guessit.submitBug(filename)

Submits a but report containing a wrongly interpreted file name

  • filename - the file name to send in the bug report

guessit.apiCall(path, queryString, request_method)

Makes a generic API call

  • path - the API endpoint path to call, e.g. /guess
  • queryString - an object containing the query string. Properties will be url escaped
  • request_method - set to true for POST method. By default GET will be used