Skip to content

Commit

Permalink
rebuild docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mceachen
mceachen committed Mar 27, 2024
1 parent 2b44d0e commit 7dd2239
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 29 deletions.
12 changes: 7 additions & 5 deletions docs/interfaces/ExifToolOptions.html
View file
Expand Up @@ -51,7 +51,7 @@
</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/ExifToolOptions.ts#L148">src/ExifToolOptions.ts:148</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="checkPerl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>check<wbr/>Perl</span><a href="#checkPerl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">check<wbr/>Perl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Should we check for a readable and executable <code>perl</code> file in $PATH? This
defaults to false on Windows, and true everywhere else. Set this to false
if you know perl is installed.</p>
</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/ExifToolOptions.ts#L238">src/ExifToolOptions.ts:238</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cleanupChildProcs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>cleanup<wbr/>Child<wbr/>Procs</span><a href="#cleanupChildProcs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cleanup<wbr/>Child<wbr/>Procs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Should batch-cluster try to clean up after spawned processes that don&#39;t
</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/ExifToolOptions.ts#L240">src/ExifToolOptions.ts:240</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cleanupChildProcs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>cleanup<wbr/>Child<wbr/>Procs</span><a href="#cleanupChildProcs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cleanup<wbr/>Child<wbr/>Procs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Should batch-cluster try to clean up after spawned processes that don&#39;t
shut down?</p>
<p>Only disable this if you have another means of PID cleanup.</p>
<p>Defaults to <code>true</code>.</p>
Expand All @@ -75,7 +75,9 @@
SIGHUP&#39;ed.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from bc.BatchProcessOptions.exitCommand</p><ul><li>Defined in node_modules/batch-cluster/dist/BatchProcessOptions.d.ts:38</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fail" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fail</span><a href="#fail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fail</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span></div><div class="tsd-comment tsd-typography"><p>Expected text to print if a command fails. Cannot be blank. Strings will
be interpreted as a regular expression fragment.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from bc.BatchProcessOptions.fail</p><ul><li>Defined in node_modules/batch-cluster/dist/BatchProcessOptions.d.ts:31</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="geoTz" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>geo<wbr/>Tz</span><a href="#geoTz" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">geo<wbr/>Tz</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">lat</span>, <span class="tsd-kind-parameter">lon</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><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><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Override the default geo-to-timezone lookup service. Note that if <a href="ExifToolOptions.html#geolocation" class="tsd-kind-property">geolocation</a> is enabled, we&#39;ll try to use {@</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from bc.BatchProcessOptions.fail</p><ul><li>Defined in node_modules/batch-cluster/dist/BatchProcessOptions.d.ts:31</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="geoTz" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>geo<wbr/>Tz</span><a href="#geoTz" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">geo<wbr/>Tz</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">lat</span>, <span class="tsd-kind-parameter">lon</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><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><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Override the default geo-to-timezone lookup service. Note that if
<a href="ExifToolOptions.html#geolocation" class="tsd-kind-property">geolocation</a> is enabled, we&#39;ll use
<a href="GeolocationTags.html#GeolocationTimeZone" class="tsd-kind-property">Tags.GeolocationTimeZone</a> if it&#39;s not blank.</p>
<p>This defaults to <code>@photostructure/tz-lookup</code>, but if you have the
resources, consider using <code>geo-tz</code> for more accurate results.</p>
<p>If your implementation throws an error, <code>ExifTool</code> will consider that given
Expand All @@ -87,10 +89,10 @@
<li><a href="https://github.com/photostructure/tz-lookup">https://github.com/photostructure/tz-lookup</a></li>
<li><a href="https://github.com/evansiroky/node-geo-tz/">https://github.com/evansiroky/node-geo-tz/</a></li>
</ul>
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/ExifToolOptions.ts#L210">src/ExifToolOptions.ts:210</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="geolocation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>geolocation</span><a href="#geolocation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">geolocation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>When reading metadata, should we enable ExifTool&#39;s geolocation features?
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/ExifToolOptions.ts#L212">src/ExifToolOptions.ts:212</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="geolocation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>geolocation</span><a href="#geolocation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">geolocation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>When reading metadata, should we enable ExifTool&#39;s geolocation features?
Note that this requires ExifTool version 12.78 or later.</p>
</div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="https://exiftool.org/geolocation.html">https://exiftool.org/geolocation.html</a></p>
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/ExifToolOptions.ts#L218">src/ExifToolOptions.ts:218</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="healthCheckCommand" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>health<wbr/>Check<wbr/>Command</span><a href="#healthCheckCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">health<wbr/>Check<wbr/>Command</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>If provided, and healthCheckIntervalMillis is greater than 0, or the
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/photostructure/exiftool-vendored.js/blob/main/src/ExifToolOptions.ts#L220">src/ExifToolOptions.ts:220</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="healthCheckCommand" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>health<wbr/>Check<wbr/>Command</span><a href="#healthCheckCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">health<wbr/>Check<wbr/>Command</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>If provided, and healthCheckIntervalMillis is greater than 0, or the
previous task failed, this command will be sent to child processes.</p>
<p>If the command outputs to stderr or returns a fail string, the process will
be considered unhealthy and recycled.</p>
Expand All @@ -104,7 +106,7 @@
<code>/opt/bin/perl</code>), if you pull in a perl layer.</p>
<p>This will default to <code>true</code> in those environments as a workaround in these
situations. Note also that <code>perl</code> will be spawned in a sub-shell.</p>
</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/ExifToolOptions.ts#L231">src/ExifToolOptions.ts:231</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="ignoreZeroZeroLatLon" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ignore<wbr/>Zero<wbr/>Zero<wbr/>Lat<wbr/>Lon</span><a href="#ignoreZeroZeroLatLon" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ignore<wbr/>Zero<wbr/>Zero<wbr/>Lat<wbr/>Lon</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Some software uses a GPS position of (0,0) as a synonym for &quot;unset&quot;. If
</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/ExifToolOptions.ts#L233">src/ExifToolOptions.ts:233</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="ignoreZeroZeroLatLon" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ignore<wbr/>Zero<wbr/>Zero<wbr/>Lat<wbr/>Lon</span><a href="#ignoreZeroZeroLatLon" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ignore<wbr/>Zero<wbr/>Zero<wbr/>Lat<wbr/>Lon</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Some software uses a GPS position of (0,0) as a synonym for &quot;unset&quot;. If
this option is true, and GPSLatitude and GPSLongitude are both 0, then
those values will be returned, but the TZ will not be inferred from that
location.</p>
Expand Down

0 comments on commit 7dd2239

Please sign in to comment.