/
jsdoc_types.js.html
126 lines (103 loc) · 6.19 KB
/
jsdoc_types.js.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>jsdoc/types.js - Documentation</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="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="TorrentLibrary.html">TorrentLibrary</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#.listVideosExtension">listVideosExtension</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#addNewPath">addNewPath</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#hasPathsProvidedByUser">hasPathsProvidedByUser</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#removeOldFiles">removeOldFiles</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#scan">scan</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#toJSON">toJSON</a></span></li><li class="nav-heading">Externals</li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-Promise.html">Promise</a></span></li><li class="nav-heading">Events</li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="TorrentLibrary.html#event:addNewPath">addNewPath</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="TorrentLibrary.html#event:error_in_function">error_in_function</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="TorrentLibrary.html#event:missing_parameter">missing_parameter</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="TorrentLibrary.html#event:removeOldFiles">removeOldFiles</a></span></li><li class="nav-heading"><span class="nav-item-type type-event">E</span><span class="nav-item-name"><a href="TorrentLibrary.html#event:scan">scan</a></span></li>
</nav>
<div id="main">
<h1 class="page-title">jsdoc/types.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>// JSDoc custom typedef
/**
* The result of parsing file name
* @typedef {Object} TorrentLibrary~TPN
* @see {@link https://github.com/clement-escolano/parse-torrent-title}
* @property {(string)} title - The file title
* @property {(number)} [season] - The season number
* @property {(number)} [episode] - The episode number
* @property {(number)} [year] - The year
* @property {(string)} [resolution] - The resolution
* @property {(string)} [codec] - The codec
* @property {(string)} [audio] - The audio
* @property {(string)} [group] - The group that releases this file
* @property {(string)} [region] - The region
* @property {(string)} [container] - The container
* @property {(string)} [language] - The file language
* @property {(boolean)} [extended] - extended ?
* @property {(boolean)} [unrated] - unrated ?
* @property {(boolean)} [proper] - proper ?
* @property {(boolean)} [repack] - repack ?
* @property {(boolean)} [convert] - convert ?
* @property {(boolean)} [hardcoded] - hardcoded ?
* @property {(boolean)} [retail] - retail ?
* @property {(boolean)} [remastered] - remastered ?
* @property {(string)} [source] - the source
*/
/**
* The extended TPN object
* @typedef {TorrentLibrary~TPN} TorrentLibrary~TPN_Extended
* @property {string} filePath - additionnal property useful for this library
*/
/**
* The variable where we store all kind of media files found in paths
* @typedef {Map.<string, {( Set<TorrentLibrary~TPN_Extended>| Map.<string,Set<TorrentLibrary~TPN_Extended>> )}>} TorrentLibrary~StoreVar
* @example
* // An example of the variable after the scan method
* [
* "MOVIES" : [
* {
* "year": 2014,
* "resolution": '1080p',
* "source": 'brrip',
* "codec": 'x264',
* "container": 'mkv',
* "title": 'Captain Russia The Summer Soldier',
* "filePath": "D:\somePath\Captain Russia The Summer Soldier (2014) 1080p BrRip x264.MKV"
* }
* ],
* "TV_SERIES" : [
* "The Blacklist" : [
* {
* "season": 4,
* "episode": 21,
* "source": "webrip",
* "codec": "xvid",
* "container": "avi",
* "language": "french"
* "filePath" : "D:\somePath\The.Blacklist.S04E21.FRENCH.WEBRip.XviD.avi"
* }
* ]
* ]
* ]
*/
</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Fri Sep 08 2017 11:55:10 GMT+0200 (Romance Daylight Time) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>