md-movie-utils
Version:
The ultimate utility to get any information about a movie
546 lines (169 loc) • 9.67 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Class: Parser | </title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-jsdoc.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/tui-doc.css">
<link type="text/css" rel="stylesheet" href=".docs.styles.css">
</head>
<body>
<nav class="lnb" id="lnb">
<div class="logo" style="width: 162px; height: 76px">
<img src="https://github.com/dibosh/md-movie-utils/raw/master/md-movie-utils-icon-invert.png" width="100%" height="100%">
</div>
<div class="title">
<h1><a href="index.html" class="link"> </a></h1>
</div>
<div class="search-container" id="search-container">
<input type="text" placeholder="Search">
<ul></ul>
</div>
<div class="lnb-api hidden"><h3>Classes</h3><ul><li><a href="BaseClient.html">BaseClient</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="BaseClient_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="BaseClient.html#get">get</a></li><li><a href="BaseClient.html#search">search</a></li></ul></div></li><li><a href="MovieDBClient.html">MovieDBClient</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="MovieDBClient_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="MovieDBClient.html#.getInstance">getInstance</a></li><li><a href="MovieDBClient.html#get">get</a></li><li><a href="MovieDBClient.html#getByIMDBId">getByIMDBId</a></li><li><a href="MovieDBClient.html#getByTitleAndYear">getByTitleAndYear</a></li><li><a href="MovieDBClient.html#getDetails">getDetails</a></li><li><a href="MovieDBClient.html#search">search</a></li></ul></div></li><li><a href="OMDBAPIClient.html">OMDBAPIClient</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="OMDBAPIClient_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="OMDBAPIClient.html#.getInstance">getInstance</a></li><li><a href="OMDBAPIClient.html#get">get</a></li><li><a href="OMDBAPIClient.html#getByIMDBId">getByIMDBId</a></li><li><a href="OMDBAPIClient.html#getByTitleAndYear">getByTitleAndYear</a></li><li><a href="OMDBAPIClient.html#search">search</a></li></ul></div></li><li><a href="Parser.html">Parser</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Parser_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="Parser.html#parseFromTorrentFileName">parseFromTorrentFileName</a></li><li><a href="Parser.html#parseMovieNameAndYear">parseMovieNameAndYear</a></li></ul></div></li></ul></div><div class="lnb-api hidden"><h3>Global</h3><ul><li><a href="global.html#toCamelCase">toCamelCase</a></li></ul></div>
</nav>
<div id="resizer"></div>
<div class="main" id="main">
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>Parser<span class="signature">()</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Parser">
new <span class="type-signature"></span>Parser<span class="signature">()</span><span class="type-signature"></span>
<div class="container-source members">
<code><a href="parser.js.html">parser.js</a></code>,
<code><a href="parser.js.html#line7">line 7</a></code>
</div>
</h4>
</dt>
<dd>
<dl class="details">
</dl>
</dd>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="parseFromTorrentFileName">
<span class="type-signature"></span>parseFromTorrentFileName<span class="signature">(movieFileName)</span><span class="type-signature"> → {object}</span>
<div class="container-source members">
<code><a href="parser.js.html">parser.js</a></code>,
<code><a href="parser.js.html#line21">line 21</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
Get movie name, year, resolution, quality and different info from a torrent file name.
Powered by parse-torrent-name module.
</div>
<div class="container-params">
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>movieFileName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Movie file torrent name</td>
</tr>
</tbody>
</table>
</div>
<div class="container-returns">
<h5>Returns:</h5>
<span class="param-type">object</span>
- The movie info
</div>
<dl class="details">
</dl>
</dd>
<dt>
<h4 class="name" id="parseMovieNameAndYear">
<span class="type-signature"></span>parseMovieNameAndYear<span class="signature">(movieFileName, format)</span><span class="type-signature"> → {object}</span>
<div class="container-source members">
<code><a href="parser.js.html">parser.js</a></code>,
<code><a href="parser.js.html#line39">line 39</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
Get a movie name & year from its filename that complies to certain format
</div>
<div class="container-params">
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>movieFileName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>format</code></td>
<td class="type">
</td>
<td class="description last">Any of the format value from `parser.formats`</td>
</tr>
</tbody>
</table>
</div>
<div class="container-returns">
<h5>Returns:</h5>
<span class="param-type">object</span>
- An object with movie name & year
</div>
<dl class="details">
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>parser.parse('Batman Begins (2005)', parser.formats.BRACES_FORMAT)</code></pre>
</dd>
</dl>
</article>
</section>
</div>
<footer>
<img class="logo" src="https://github.com/dibosh/md-movie-utils/raw/master/md-movie-utils-icon-invert.png" style="width: 162px; height: 76px">
<div class="footer-text">If you liked the module, don't forget to hit a star on github: https://github.com/dibosh/md-movie-utils</div>
</footer>
<script>prettyPrint();</script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/tui-doc.js"></script>
<script src="scripts/linenumber.js"></script>
<script>
var id = 'Parser_sub'.replace(/"/g, '_');
var selectedApi = document.getElementById(id); // do not use jquery selector
var $selectedApi = $(selectedApi);
$selectedApi.removeClass('hidden');
$selectedApi.parent().find('.glyphicon').removeClass('glyphicon-plus').addClass('glyphicon-minus');
showLnbApi();
</script>
</body>
</html>