This package helps you extract information from a torrent name such as language, resolution and codec. This was forked and updated from TheBeastLT's Fork of parse-torrent-title. While the fork is quite good, there are many instances where it has failed, so we decided to modify it ourselves. Most new regexes come from dreulavelle's PTT, which is a rewrite of parse-torrent-title in Python.
You can install it using npm:
npm install https://github.com/TorBox-App/parse-torrent-title.git
You should use Node 8.0 or higher to use this package.
A simple usage is as follows:
import ptt from "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
value
(default to undefined) which, if defined, set the specified value instead of the matching part as the result
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 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
If you add new properties with addHandler
in TypeScript, the result type DefaultParserResult
will not be updated,
and you will encounter a TS2339 error.
To prevent this error and have autocomplete,
you should create a ParserResult
interface with the expected properties.
It is possible to extend the DefaultParserResult
interface to get all the default properties.
Then, create a new Parser
object using the above interface.
Finally, use the parse
function as usual.
Example:
import { Parser, DefaultParserResult, addDefaults } from "parse-torrent-title";
interface ParserResult extends DefaultParserResult {
part?: number;
}
const parser = new Parser<ParserResult>();
addDefaults(parser);
parser.addHandler('part', /(?:Part|CD)[. ]?([0-9])/i, { type: 'integer' })
const parse = parser.parse;
const result = parse('Watergate.2018.Part1.DOC.SUBFRENCH.1080p.HDTV.H264-ELEARNiNG');
console.log(result.year); // 2018 - it works as before
console.log(result.part); // 1 - `part` is now a known property of the `result` object