This package helps you extract information from a torrent name such as language, resolution and codec.
You can install it using npm:
npm install parse-torrent-title
You should use Node 6.0 or higher to use this package.
A simple usage is as follow:
const ptt = require("parse-torrent-title");
const information = ptt.parse("Game.of.Thrones.S01E01.720p.HDTV.x264-CTU");
console.log(information.title); // Game of Thrones
console.log(information.season); // 1
console.log(information.episode); // 1
console.log(information.resolution); // 720p
console.log(information.codec); // x264
console.log(information.source); // HDTV
console.log(information.group); // CTU
This module is configurable and extendable using handlers and regular expressions.
If you want an extra field to be populated, you can use a regular expression as follow:
const ptt = require("parse-torrent-title");
ptt.addHandler("part", /Part[. ]([0-9])/i, { type: "integer" });
const information = ptt.parse("Silent.Witness.S18E03.Falling.Angels.Part.1.720p.HDTV.x264-FTP");
console.log(information.part); // 1
If you want to keep only a part of the matched regular expression, you should use capturing groups explained here.
For regular expressions, the following options are available:
skipIfAlreadyFound
(default totrue
) which will skip the regular expression if a previous handler for the same information already found something.type
(default tostring
)which indicates what is the expected output of the regular expression. It can be:string
: does nothinginteger
: convert the matching part into an integerlowercase
: convert the matching part to lowercaseboolean
: convert to true if there is a matching part
A handler is a function with the title and the resulting information as parameters. It can modify the result in any wanted way. If the matched string is not part of the title, it should return the beginning of it.
const ptt = require("parse-torrent-title");
const information = ptt.parse("[REQ] Harry Potter And The Prisoner Of Azkaban 2004 1080p BluRay DTS x264-hV");
console.log(information.isHarryPotterRelated); // undefined
ptt.addHandler(({ title, result }) => {
const match = title.match(/harry.potter/i);
if (match) {
result.isHarryPotterRelated = true;
}
});
const information2 = ptt.parse("[REQ] Harry Potter And The Prisoner Of Azkaban 2004 1080p BluRay DTS x264-hV");
console.log(information2.isHarryPotterRelated); // true
You may want several different parsers within the same project. To do that, you can simply create new parsers:
const { Parser } = require("parse-torrent-title");
const parser = new Parser();
const anotherParser = new Parser();
By default, a freshly created parser has no handler. If you want to add default handlers to a parser, you can do so using the specific method:
const { Parser, addDefaults } = require("parse-torrent-title");
const parser = new Parser();
addDefaults(parser); // parser is now ready