Skip to content

Commit

Permalink
yarn docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mceachen committed Sep 4, 2023
1 parent f2846fe commit 1ad20da
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/functions/offsetMinutesToZoneName.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ <h5><span class="tsd-kind-parameter">offsetMinutes</span>: <a href="../types/May
<h4 class="tsd-returns-title">Returns <a href="../types/Maybe.html" class="tsd-signature-type tsd-kind-type-alias">Maybe</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/Timezones.ts#L60">src/Timezones.ts:60</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/Timezones.ts#L62">src/Timezones.ts:62</a></li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
5 changes: 0 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -176,10 +176,6 @@ <h2>exiftool-vendored</h2></div>
</ol>
<pre><code class="language-js"><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-5">ExifTool</span><span class="hl-0">({ </span><span class="hl-1">exiftoolEnv:</span><span class="hl-0"> { </span><span class="hl-1">EXIFTOOL_HOME:</span><span class="hl-0"> </span><span class="hl-5">resolve</span><span class="hl-0">(</span><span class="hl-6">&quot;path&quot;</span><span class="hl-0">, </span><span class="hl-6">&quot;to&quot;</span><span class="hl-0">, </span><span class="hl-6">&quot;config&quot;</span><span class="hl-0">, </span><span class="hl-6">&quot;dir&quot;</span><span class="hl-0">) }</span>
</code><button>Copy</button></pre>
<a id="md:this-package-requires-procps" class="tsd-anchor"></a><h2><a href="#md:this-package-requires-procps">This package requires <code>procps</code>.</a></h2><p>The default <code>BatchClusterOptions.cleanupChildProcs</code> value of <code>true</code> means that BatchCluster, which is used to manage child <code>exiftool</code> processes, will try to use <code>ps</code> to ensure Node&#39;s view of process state are correct, and that errant
processes are cleaned up.</p>
<p>If you run this in a docker image based on Alpine or Debian Slim, <strong>this won&#39;t work properly unless you install the <code>procps</code> package.</strong></p>
<p><a href="https://github.com/photostructure/batch-cluster.js/issues/13">See <code>batch-cluster</code> for details.</a></p>
<a id="md:resource-hygiene" class="tsd-anchor"></a><h2><a href="#md:resource-hygiene">Resource hygiene</a></h2><p><strong>Call <code>ExifTool.end()</code> when you&#39;re done</strong></p>
<p>You must explicitly call
<a href="https://photostructure.github.io/exiftool-vendored.js/classes/ExifTool.html#end"><code>.end()</code></a>
Expand Down Expand Up @@ -334,7 +330,6 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="#md:always-beware-timezones"><span>Always <wbr/>Beware: <wbr/>Timezones</span></a></li>
<li><a href="#md:rewriting-tags"><span>Rewriting tags</span></a></li>
<li><a href="#md:exiftool-configuration-support-exiftool_config"><span>Exif<wbr/>Tool configuration support (.<wbr/>Exif<wbr/>Tool_<wbr/>config)</span></a></li></ul></li>
<li><a href="#md:this-package-requires-procps"><span>This package requires procps.</span></a></li>
<li><a href="#md:resource-hygiene"><span>Resource hygiene</span></a></li>
<li>
<ul>
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/ApplicationRecordTags.html
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
<li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/ApplicationRecordTags.ts#L20">src/ApplicationRecordTags.ts:20</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="ExpirationTime" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Expiration<wbr/>Time</span><a href="#ExpirationTime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">Expiration<wbr/>Time</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../classes/ExifDateTime.html" class="tsd-signature-type tsd-kind-class">ExifDateTime</a><span class="tsd-signature-symbol"> | </span><a href="../classes/ExifTime.html" class="tsd-signature-type tsd-kind-class">ExifTime</a></div><aside class="tsd-sources">
<div class="tsd-signature"><span class="tsd-kind-property">Expiration<wbr/>Time</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../classes/ExifTime.html" class="tsd-signature-type tsd-kind-class">ExifTime</a><span class="tsd-signature-symbol"> | </span><a href="../classes/ExifDateTime.html" class="tsd-signature-type tsd-kind-class">ExifDateTime</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/ApplicationRecordTags.ts#L21">src/ApplicationRecordTags.ts:21</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="FixtureIdentifier" class="tsd-anchor"></a>
Expand Down Expand Up @@ -354,7 +354,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
<li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/ApplicationRecordTags.ts#L18">src/ApplicationRecordTags.ts:18</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="ReleaseTime" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Release<wbr/>Time</span><a href="#ReleaseTime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">Release<wbr/>Time</span><span class="tsd-signature-symbol">?:</span> <a href="../classes/ExifDateTime.html" class="tsd-signature-type tsd-kind-class">ExifDateTime</a><span class="tsd-signature-symbol"> | </span><a href="../classes/ExifTime.html" class="tsd-signature-type tsd-kind-class">ExifTime</a></div><aside class="tsd-sources">
<div class="tsd-signature"><span class="tsd-kind-property">Release<wbr/>Time</span><span class="tsd-signature-symbol">?:</span> <a href="../classes/ExifTime.html" class="tsd-signature-type tsd-kind-class">ExifTime</a><span class="tsd-signature-symbol"> | </span><a href="../classes/ExifDateTime.html" class="tsd-signature-type tsd-kind-class">ExifDateTime</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/ApplicationRecordTags.ts#L19">src/ApplicationRecordTags.ts:19</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="ShortDocumentID" class="tsd-anchor"></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/Tags.html
Original file line number Diff line number Diff line change
Expand Up @@ -8531,7 +8531,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
<li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/ApplicationRecordTags.ts#L20">src/ApplicationRecordTags.ts:20</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="ExpirationTime" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Expiration<wbr/>Time</span><a href="#ExpirationTime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">Expiration<wbr/>Time</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../classes/ExifDateTime.html" class="tsd-signature-type tsd-kind-class">ExifDateTime</a><span class="tsd-signature-symbol"> | </span><a href="../classes/ExifTime.html" class="tsd-signature-type tsd-kind-class">ExifTime</a></div><aside class="tsd-sources">
<div class="tsd-signature"><span class="tsd-kind-property">Expiration<wbr/>Time</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../classes/ExifTime.html" class="tsd-signature-type tsd-kind-class">ExifTime</a><span class="tsd-signature-symbol"> | </span><a href="../classes/ExifDateTime.html" class="tsd-signature-type tsd-kind-class">ExifDateTime</a></div><aside class="tsd-sources">
<p>Inherited from <a href="ApplicationRecordTags.html">ApplicationRecordTags</a>.<a href="ApplicationRecordTags.html#ExpirationTime">ExpirationTime</a></p>
<ul>
<li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/ApplicationRecordTags.ts#L21">src/ApplicationRecordTags.ts:21</a></li></ul></aside></section>
Expand Down Expand Up @@ -18550,7 +18550,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
<li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/Tags.ts#L3457">src/Tags.ts:3457</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="ReleaseTime" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Release<wbr/>Time</span><a href="#ReleaseTime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">Release<wbr/>Time</span><span class="tsd-signature-symbol">?:</span> <a href="../classes/ExifDateTime.html" class="tsd-signature-type tsd-kind-class">ExifDateTime</a><span class="tsd-signature-symbol"> | </span><a href="../classes/ExifTime.html" class="tsd-signature-type tsd-kind-class">ExifTime</a></div><aside class="tsd-sources">
<div class="tsd-signature"><span class="tsd-kind-property">Release<wbr/>Time</span><span class="tsd-signature-symbol">?:</span> <a href="../classes/ExifTime.html" class="tsd-signature-type tsd-kind-class">ExifTime</a><span class="tsd-signature-symbol"> | </span><a href="../classes/ExifDateTime.html" class="tsd-signature-type tsd-kind-class">ExifDateTime</a></div><aside class="tsd-sources">
<p>Inherited from <a href="ApplicationRecordTags.html">ApplicationRecordTags</a>.<a href="ApplicationRecordTags.html#ReleaseTime">ReleaseTime</a></p>
<ul>
<li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/ApplicationRecordTags.ts#L19">src/ApplicationRecordTags.ts:19</a></li></ul></aside></section>
Expand Down
2 changes: 1 addition & 1 deletion docs/variables/UnsetZone.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ <h1>Variable UnsetZone<code class="tsd-tag ts-flagConst">Const</code> </h1></div
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/Timezones.ts#L23">src/Timezones.ts:23</a></li></ul></aside></div>
<li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/Timezones.ts#L25">src/Timezones.ts:25</a></li></ul></aside></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/variables/UnsetZoneName.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <h1>Variable UnsetZoneName<code class="tsd-tag ts-flagConst">Const</code> </h1><
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/Timezones.ts#L28">src/Timezones.ts:28</a></li></ul></aside></div>
<li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/Timezones.ts#L30">src/Timezones.ts:30</a></li></ul></aside></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/variables/UnsetZoneOffsetMinutes.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <h1>Variable UnsetZoneOffsetMinutes<code class="tsd-tag ts-flagConst">Const</cod
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/Timezones.ts#L17">src/Timezones.ts:17</a></li></ul></aside></div>
<li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/Timezones.ts#L19">src/Timezones.ts:19</a></li></ul></aside></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion docs/variables/defaultVideosToUTC.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ <h1>Variable defaultVideosToUTC<code class="tsd-tag ts-flagConst">Const</code> <
<h4>See</h4><p><a href="https://github.com/photostructure/exiftool-vendored.js/issues/113">https://github.com/photostructure/exiftool-vendored.js/issues/113</a></p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/Timezones.ts#L35">src/Timezones.ts:35</a></li></ul></aside></div>
<li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/Timezones.ts#L37">src/Timezones.ts:37</a></li></ul></aside></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down

0 comments on commit 1ad20da

Please sign in to comment.