readme/doc

Author: farfromrefug

docs/assets/search.js

@@ -24,7 +24,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">EventData</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/image/index.d.ts:248</li></ul></aside>
+<li>Defined in packages/image/index.d.ts:254</li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -55,14 +55,14 @@ <h3 class="tsd-anchor-link"><span>event<wbr/>Name</span><a href="#eventName" ari
 <div class="tsd-comment tsd-typography"><p>Returns the name of the event that has been fired.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/image/index.d.ts:252</li></ul></aside></section>
+<li>Defined in packages/image/index.d.ts:258</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="object" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>object</span><a href="#object" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
 <div class="tsd-comment tsd-typography"><p>The object that fires the event.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/image/index.d.ts:257</li></ul></aside></section></section></div>
+<li>Defined in packages/image/index.d.ts:263</li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/classes/image.EventData.html

@@ -24,7 +24,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">FailureEventData</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/image/index.d.ts:305</li></ul></aside>
+<li>Defined in packages/image/index.d.ts:311</li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -56,21 +56,21 @@ <h3 class="tsd-anchor-link"><span>error</span><a href="#error" aria-label="Perma
 <div class="tsd-comment tsd-typography"><p>An object containing information about the status of the event.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/image/index.d.ts:319</li></ul></aside></section>
+<li>Defined in packages/image/index.d.ts:325</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="eventName" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>event<wbr/>Name</span><a href="#eventName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">event<wbr/>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 <div class="tsd-comment tsd-typography"><p>Returns the name of the event that has been fired.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/image/index.d.ts:309</li></ul></aside></section>
+<li>Defined in packages/image/index.d.ts:315</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="object" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>object</span><a href="#object" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
 <div class="tsd-comment tsd-typography"><p>The object that fires the event.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/image/index.d.ts:314</li></ul></aside></section></section></div>
+<li>Defined in packages/image/index.d.ts:320</li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/classes/image.FailureEventData.html

@@ -24,7 +24,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">FinalEventData</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/image/index.d.ts:263</li></ul></aside>
+<li>Defined in packages/image/index.d.ts:269</li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -56,33 +56,33 @@ <h2>Properties</h2>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>android</span><a href="#android" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">android<span class="tsd-signature-symbol">?:</span> <a href="../interfaces/image.AnimatedImage.html" class="tsd-signature-type" data-tsd-kind="Interface">AnimatedImage</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/image/index.d.ts:278</li></ul></aside></section>
+<li>Defined in packages/image/index.d.ts:284</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="eventName" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>event<wbr/>Name</span><a href="#eventName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">event<wbr/>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 <div class="tsd-comment tsd-typography"><p>Returns the name of the event that has been fired.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/image/index.d.ts:267</li></ul></aside></section>
+<li>Defined in packages/image/index.d.ts:273</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="imageInfo" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>image<wbr/>Info</span><a href="#imageInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">image<wbr/>Info<span class="tsd-signature-symbol">:</span> <a href="image.ImageInfo.html" class="tsd-signature-type" data-tsd-kind="Class">ImageInfo</a></div>
 <div class="tsd-comment tsd-typography"><p>Contains information about an image.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/image/index.d.ts:277</li></ul></aside></section>
+<li>Defined in packages/image/index.d.ts:283</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="ios" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>ios</span><a href="#ios" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">ios<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/image/index.d.ts:279</li></ul></aside></section>
+<li>Defined in packages/image/index.d.ts:285</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="object" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>object</span><a href="#object" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
 <div class="tsd-comment tsd-typography"><p>The object that fires the event.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/image/index.d.ts:272</li></ul></aside></section></section></div>
+<li>Defined in packages/image/index.d.ts:278</li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/classes/image.FinalEventData.html

@@ -24,7 +24,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">ImageInfo</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/image/index.d.ts:217</li></ul></aside>
+<li>Defined in packages/image/index.d.ts:223</li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -57,23 +57,23 @@ <h3 class="tsd-anchor-link"><span>get<wbr/>Height</span><a href="#getHeight" ari
 <li class="tsd-description">
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/image/index.d.ts:218</li></ul></aside></li></ul></section>
+<li>Defined in packages/image/index.d.ts:224</li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getQualityInfo" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>get<wbr/>Quality<wbr/>Info</span><a href="#getQualityInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
 <li class="tsd-signature tsd-anchor-link" id="getQualityInfo.getQualityInfo-1">get<wbr/>Quality<wbr/>Info<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/image.QualityInfo.html" class="tsd-signature-type" data-tsd-kind="Interface">QualityInfo</a><a href="#getQualityInfo.getQualityInfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
 <li class="tsd-description">
 <h4 class="tsd-returns-title">Returns <a href="../interfaces/image.QualityInfo.html" class="tsd-signature-type" data-tsd-kind="Interface">QualityInfo</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/image/index.d.ts:222</li></ul></aside></li></ul></section>
+<li>Defined in packages/image/index.d.ts:228</li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getWidth" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>get<wbr/>Width</span><a href="#getWidth" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
 <li class="tsd-signature tsd-anchor-link" id="getWidth.getWidth-1">get<wbr/>Width<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getWidth.getWidth-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
 <li class="tsd-description">
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/image/index.d.ts:220</li></ul></aside></li></ul></section></section></div>
+<li>Defined in packages/image/index.d.ts:226</li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">