moleculer-ncore v0.3.0
Moleculer-ncore
This service provides actions for accessing nCore torrent provider. It utilizes the file streaming capabilities of the moleculer framework for downloading torrent file.
Features
The following list details which features are implemented
- Sign in to nCore website
- Get movies according to filter criterias
- Get movie details and versions by nCore or IMDB id
- Download a torrent file
Install
npm install moleculer-ncore --saveUsage
const { ServiceBroker } = require("moleculer");
const NcoreService = require("moleculer-ncore");
const broker = new ServiceBroker({ logger: console });
// Create a service
broker.createService({
mixins: NcoreService,
settings: {
username: "*******",
password: "*******",
url: "https://ncore.pro"
}
});Settings
| Property | Type | Default | Description |
|---|---|---|---|
username | String | required | The username for nCore login |
password | String | required | The password for nCore login |
url | String | https://ncore.pro | The url of the nCore website |
Actions
getMovies
List movies
Parameters
| Property | Type | Default | Description |
|---|---|---|---|
genres | array | [] | The genres of the movies |
sortBy | string | uploaded | The attribute to be used for ordering |
sortDirection | string | DESC | The direction of the ordering |
Results
Type: PromiseLike.<(Array.<Object>|Error)>
getMovieById
Get a movie by nCore id.
Parameters
| Property | Type | Default | Description |
|---|---|---|---|
id | string | required | nCore id of the movie |
Results
Type: PromiseLike.<(object|Error)>
getMovieByImdb
Get a movie by IMDB id.
Parameters
| Property | Type | Default | Description |
|---|---|---|---|
imdbId | string | required | IMDB id of the movie |
Results
Type: PromiseLike.<(object|Error)>
getTorrentFile
Get a Node stream that represents the downloadable torrent file of the given movie.
Parameters
| Property | Type | Default | Description |
|---|---|---|---|
id | string | required | nCore id of the movie |
Results
Type: PromiseLike.<(stream|Error)>
Test
$ npm testIn development with watching
$ npm run ciContribution
Please send pull requests improving the usage and fixing bugs, improving documentation and providing better examples, or providing some testing, because these things are important.
License
The project is available under the MIT license.
Contact
Copyright (c) 2021 Zoltan Kakuk
