Variable

Static Public Summary
public	Anime: Anime A model object for anime shows.
public	Movie: Movie A model object for movies.
public	Promise: Promise The promise object to override the mongoose promise object.
public	Show: Show A model object for shows.
public	animeMap: Object Map object for correcting anime slugs.
public	collections: Array An array of the supported collections for mongodb.
public	cronTime: String The cron time for scraping torrents.
public	dbHosts: Array The host of the server of the database.
public	dbName: String The name of the database.
public	extratorrentAnimeProviders: Array The providers for scraping ExtraTorrent for anime.
public	extratorrentMovieProviders: Array The providers for scraping ExtraTorrent for movies.
public	extratorrentShowProviders: Array The providers for scraping ExtraTorrent for shows.
public	fanart: Trakt A configured Fanart API.
public	katAnimeProviders: Array The providers for scraping KAT for anime.
public	katMovieProviders: Array The providers for scraping KAT for movies.
public	katShowProviders: Array The providers for scraping KAT for shows.
public	master: Boolean Check if this instance of the API is the master.
public	maxWebRequest: Integer The maximum web requests can take place at the same time.
public	movieMap: Object Map object for correcting movie slugs.
public	nyaaAnimeProviders: Array The providers for scraping Nyaa for anime.
public	omdb: OMDB A configured OMDB API.
public	pageSize: Integer The amount of object show per page.
public	port: Integer The port on which the API will run on.
public	server: String The name of the server.
public	showMap: Object Map object for correcting show slugs.
public	statusFile: String The name of the status file holding the `status` value for the index page.
public	tempDir: String The path to the temprary directory..
public	timeZone: String The timezone the conjob will hold.
public	tmdb: TMDB A configured TMDB API.
public	trakt: Trakt A configured Trakt API.
public	tvdb: TVDB A configured TVDB API.
public	updatedFile: String The name of the updated file holding the `updated` value for the index page.
public	webRequestTimeout: Integer The maximum time a web request may take.
public	workers: Integer The amount of workers on the cluster.

Static Public

public Anime: Anime source

import Anime from 'popcorn-api/src/models/Anime.js'

A model object for anime shows.

public Movie: Movie source

import Movie from 'popcorn-api/src/models/Movie.js'

A model object for movies.

public Promise: Promise source

import {Promise} from 'popcorn-api/src/config/constants.js'

The promise object to override the mongoose promise object. Default is global.Promise.

public Show: Show source

import Show from 'popcorn-api/src/models/Show.js'

A model object for shows.

public animeMap: Object source

import {animeMap} from 'popcorn-api/src/config/constants.js'

Map object for correcting anime slugs.

public collections: Array source

import {collections} from 'popcorn-api/src/config/constants.js'

An array of the supported collections for mongodb.

public cronTime: String source

import {cronTime} from 'popcorn-api/src/config/constants.js'

The cron time for scraping torrents. Default is 0 0 *\/6 * * *.

public dbHosts: Array source

import {dbHosts} from 'popcorn-api/src/config/constants.js'

The host of the server of the database. Default is ["localhost"].

public dbName: String source

import {dbName} from 'popcorn-api/src/config/constants.js'

The name of the database. Default is popcorn.

public extratorrentAnimeProviders: Array source

import {extratorrentAnimeProviders} from 'popcorn-api/src/config/constants.js'

The providers for scraping ExtraTorrent for anime.

public extratorrentMovieProviders: Array source

import {extratorrentMovieProviders} from 'popcorn-api/src/config/constants.js'

The providers for scraping ExtraTorrent for movies.

public extratorrentShowProviders: Array source

import {extratorrentShowProviders} from 'popcorn-api/src/config/constants.js'

The providers for scraping ExtraTorrent for shows.

public fanart: Trakt source

import {fanart} from 'popcorn-api/src/config/constants.js'

A configured Fanart API.

See:

https://github.com/vankasteelj/trakt.tv

public katAnimeProviders: Array source

import {katAnimeProviders} from 'popcorn-api/src/config/constants.js'

The providers for scraping KAT for anime.

public katMovieProviders: Array source

import {katMovieProviders} from 'popcorn-api/src/config/constants.js'

The providers for scraping KAT for movies.

public katShowProviders: Array source

import {katShowProviders} from 'popcorn-api/src/config/constants.js'

The providers for scraping KAT for shows.

public master: Boolean source

import {master} from 'popcorn-api/src/config/constants.js'

Check if this instance of the API is the master. Default is true.

public maxWebRequest: Integer source

import {maxWebRequest} from 'popcorn-api/src/config/constants.js'

The maximum web requests can take place at the same time. Default is 2.

public movieMap: Object source

import {movieMap} from 'popcorn-api/src/config/constants.js'

Map object for correcting movie slugs.

public nyaaAnimeProviders: Array source

import {nyaaAnimeProviders} from 'popcorn-api/src/config/constants.js'

The providers for scraping Nyaa for anime.

public omdb: OMDB source

import {omdb} from 'popcorn-api/src/config/constants.js'

A configured OMDB API.

See:

https://github.com/ChrisAlderson/omdb-api-pt

public pageSize: Integer source

import {pageSize} from 'popcorn-api/src/config/constants.js'

The amount of object show per page. Default is 50.

public port: Integer source

import {port} from 'popcorn-api/src/config/constants.js'

The port on which the API will run on. Default is 5000.

public server: String source

import {server} from 'popcorn-api/src/config/constants.js'

The name of the server. Default is serv01.

public showMap: Object source

import {showMap} from 'popcorn-api/src/config/constants.js'

Map object for correcting show slugs.

public statusFile: String source

import {statusFile} from 'popcorn-api/src/config/constants.js'

The name of the status file holding the status value for the index page. Default is status.json.

public tempDir: String source

import {tempDir} from 'popcorn-api/src/config/constants.js'

The path to the temprary directory.. Default is ./tmp.

public timeZone: String source

import {timeZone} from 'popcorn-api/src/config/constants.js'

The timezone the conjob will hold. Default is America/Los_Angeles.

public tmdb: TMDB source

import {tmdb} from 'popcorn-api/src/config/constants.js'

A configured TMDB API.

See:

https://github.com/sarathkcm/TheMovieDBClient

public trakt: Trakt source

import {trakt} from 'popcorn-api/src/config/constants.js'

A configured Trakt API.

See:

https://github.com/vankasteelj/trakt.tv

public tvdb: TVDB source

import {tvdb} from 'popcorn-api/src/config/constants.js'

A configured TVDB API.

See:

https://github.com/edwellbrook/node-tvdb

public updatedFile: String source

import {updatedFile} from 'popcorn-api/src/config/constants.js'

The name of the updated file holding the updated value for the index page. Default is lastUpdated.json.

public webRequestTimeout: Integer source

import {webRequestTimeout} from 'popcorn-api/src/config/constants.js'

The maximum time a web request may take. Default is 2 seconds.

public workers: Integer source

import {workers} from 'popcorn-api/src/config/constants.js'

The amount of workers on the cluster. Default is 2.