Skip to content

Commit

Permalink
docs: generate documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@federicocarboni
federicocarboni committed Nov 2, 2020
1 parent cac7bb5 commit 43587bd
Show file tree
Hide file tree
Showing 22 changed files with 229 additions and 227 deletions.
8 changes: 4 additions & 4 deletions docs/classes/_src_lib_.ffmpegerror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FFmpegError | Eloquent FFmpeg - v0.12.0-alpha.0</title>
<title>FFmpegError | Eloquent FFmpeg - v0.12.1-alpha.0</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
Expand All @@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Eloquent FFmpeg - v0.12.0-alpha.0</a>
<a href="../index.html" class="title">Eloquent FFmpeg - v0.12.1-alpha.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand Down Expand Up @@ -117,7 +117,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/errors.ts#L5">src/errors.ts:5</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/errors.ts#L5">src/errors.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -175,7 +175,7 @@ <h3>stderr</h3>
<div class="tsd-signature tsd-kind-icon">stderr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/errors.ts#L6">src/errors.ts:6</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/errors.ts#L6">src/errors.ts:6</a></li>
</ul>
</aside>
</section>
Expand Down
10 changes: 5 additions & 5 deletions docs/classes/_src_lib_.ffprobeerror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FFprobeError | Eloquent FFmpeg - v0.12.0-alpha.0</title>
<title>FFprobeError | Eloquent FFmpeg - v0.12.1-alpha.0</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
Expand All @@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Eloquent FFmpeg - v0.12.0-alpha.0</a>
<a href="../index.html" class="title">Eloquent FFmpeg - v0.12.1-alpha.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand Down Expand Up @@ -118,7 +118,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/errors.ts#L15">src/errors.ts:15</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/errors.ts#L15">src/errors.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -146,7 +146,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> code</h3>
<div class="tsd-signature tsd-kind-icon">code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/errors.ts#L16">src/errors.ts:16</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/errors.ts#L16">src/errors.ts:16</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -189,7 +189,7 @@ <h3>stderr</h3>
<div class="tsd-signature tsd-kind-icon">stderr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/errors.ts#L16">src/errors.ts:16</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/errors.ts#L16">src/errors.ts:16</a></li>
</ul>
</aside>
</section>
Expand Down
22 changes: 11 additions & 11 deletions docs/enums/_src_lib_.loglevel.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LogLevel | Eloquent FFmpeg - v0.12.0-alpha.0</title>
<title>LogLevel | Eloquent FFmpeg - v0.12.1-alpha.0</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
Expand All @@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Eloquent FFmpeg - v0.12.0-alpha.0</a>
<a href="../index.html" class="title">Eloquent FFmpeg - v0.12.1-alpha.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand Down Expand Up @@ -103,7 +103,7 @@ <h3>Debug</h3>
<div class="tsd-signature tsd-kind-icon">Debug<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;debug&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/command.ts#L32">src/command.ts:32</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/command.ts#L32">src/command.ts:32</a></li>
</ul>
</aside>
</section>
Expand All @@ -113,7 +113,7 @@ <h3>Error</h3>
<div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;error&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/command.ts#L28">src/command.ts:28</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/command.ts#L28">src/command.ts:28</a></li>
</ul>
</aside>
</section>
Expand All @@ -123,7 +123,7 @@ <h3>Fatal</h3>
<div class="tsd-signature tsd-kind-icon">Fatal<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;fatal&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/command.ts#L27">src/command.ts:27</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/command.ts#L27">src/command.ts:27</a></li>
</ul>
</aside>
</section>
Expand All @@ -133,7 +133,7 @@ <h3>Info</h3>
<div class="tsd-signature tsd-kind-icon">Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;info&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/command.ts#L30">src/command.ts:30</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/command.ts#L30">src/command.ts:30</a></li>
</ul>
</aside>
</section>
Expand All @@ -143,7 +143,7 @@ <h3>Panic</h3>
<div class="tsd-signature tsd-kind-icon">Panic<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;panic&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/command.ts#L26">src/command.ts:26</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/command.ts#L26">src/command.ts:26</a></li>
</ul>
</aside>
</section>
Expand All @@ -153,7 +153,7 @@ <h3>Quiet</h3>
<div class="tsd-signature tsd-kind-icon">Quiet<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;quiet&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/command.ts#L25">src/command.ts:25</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/command.ts#L25">src/command.ts:25</a></li>
</ul>
</aside>
</section>
Expand All @@ -163,7 +163,7 @@ <h3>Trace</h3>
<div class="tsd-signature tsd-kind-icon">Trace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;trace&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/command.ts#L33">src/command.ts:33</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/command.ts#L33">src/command.ts:33</a></li>
</ul>
</aside>
</section>
Expand All @@ -173,7 +173,7 @@ <h3>Verbose</h3>
<div class="tsd-signature tsd-kind-icon">Verbose<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;verbose&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/command.ts#L31">src/command.ts:31</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/command.ts#L31">src/command.ts:31</a></li>
</ul>
</aside>
</section>
Expand All @@ -183,7 +183,7 @@ <h3>Warning</h3>
<div class="tsd-signature tsd-kind-icon">Warning<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;warning&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/command.ts#L29">src/command.ts:29</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/command.ts#L29">src/command.ts:29</a></li>
</ul>
</aside>
</section>
Expand Down
88 changes: 44 additions & 44 deletions docs/globals.html
View file

Large diffs are not rendered by default.

7 changes: 3 additions & 4 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Eloquent FFmpeg - v0.12.0-alpha.0</title>
<title>Eloquent FFmpeg - v0.12.1-alpha.0</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
Expand All @@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">Eloquent FFmpeg - v0.12.0-alpha.0</a>
<a href="index.html" class="title">Eloquent FFmpeg - v0.12.1-alpha.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand All @@ -49,7 +49,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
</ul>
<h1>Eloquent FFmpeg - v0.12.0-alpha.0</h1>
<h1>Eloquent FFmpeg - v0.12.1-alpha.0</h1>
</div>
</div>
</header>
Expand All @@ -69,7 +69,6 @@ <h1>Eloquent FFmpeg</h1>
pull request to change it. This library is still in a very early stage, but
there shouldn&#39;t be any major breaking changes.</p>
<p><strong>Only NodeJS 10.x or higher is supported</strong></p>
<p><strong>Note:</strong> The preview version of the library can be installed with <code>npm i eloquent-ffmpeg@next</code>.</p>
<a href="#prerequisites" id="prerequisites" style="color: inherit; text-decoration: none;">
<h2>Prerequisites</h2>
</a>
Expand Down
12 changes: 6 additions & 6 deletions docs/interfaces/_src_lib_.codecs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Codecs | Eloquent FFmpeg - v0.12.0-alpha.0</title>
<title>Codecs | Eloquent FFmpeg - v0.12.1-alpha.0</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
Expand All @@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Eloquent FFmpeg - v0.12.0-alpha.0</a>
<a href="../index.html" class="title">Eloquent FFmpeg - v0.12.1-alpha.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand Down Expand Up @@ -98,7 +98,7 @@ <h3>audio</h3>
<div class="tsd-signature tsd-kind-icon">audio<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/info.ts#L124">src/info.ts:124</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/info.ts#L124">src/info.ts:124</a></li>
</ul>
</aside>
</section>
Expand All @@ -108,7 +108,7 @@ <h3>data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/info.ts#L126">src/info.ts:126</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/info.ts#L126">src/info.ts:126</a></li>
</ul>
</aside>
</section>
Expand All @@ -118,7 +118,7 @@ <h3>subtitle</h3>
<div class="tsd-signature tsd-kind-icon">subtitle<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/info.ts#L125">src/info.ts:125</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/info.ts#L125">src/info.ts:125</a></li>
</ul>
</aside>
</section>
Expand All @@ -128,7 +128,7 @@ <h3>video</h3>
<div class="tsd-signature tsd-kind-icon">video<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/info.ts#L123">src/info.ts:123</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/info.ts#L123">src/info.ts:123</a></li>
</ul>
</aside>
</section>
Expand Down
8 changes: 4 additions & 4 deletions docs/interfaces/_src_lib_.concatoptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ConcatOptions | Eloquent FFmpeg - v0.12.0-alpha.0</title>
<title>ConcatOptions | Eloquent FFmpeg - v0.12.1-alpha.0</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
Expand All @@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Eloquent FFmpeg - v0.12.0-alpha.0</a>
<a href="../index.html" class="title">Eloquent FFmpeg - v0.12.1-alpha.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
Expand Down Expand Up @@ -100,7 +100,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> protocols</h3>
<div class="tsd-signature tsd-kind-icon">protocols<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/command.ts#L135">src/command.ts:135</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/command.ts#L135">src/command.ts:135</a></li>
</ul>
</aside>
</section>
Expand All @@ -110,7 +110,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> safe</h3>
<div class="tsd-signature tsd-kind-icon">safe<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/d1168d5/src/command.ts#L134">src/command.ts:134</a></li>
<li>Defined in <a href="https://github.com/FedericoCarboni/eloquent-ffmpeg/blob/cac7bb5/src/command.ts#L134">src/command.ts:134</a></li>
</ul>
</aside>
</section>
Expand Down
Loading

0 comments on commit 43587bd

Please sign in to comment.