Skip to content

Commit

Permalink
adds documentation for v5.2.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@desaikd
desaikd committed Apr 30, 2024
1 parent 7fceb43 commit b008bcd
Show file tree
Hide file tree
Showing 75 changed files with 7,493 additions and 9,762 deletions.
42 changes: 21 additions & 21 deletions api/classes/abstractwriter.abstractwriter-1.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ <h3>add<wbr>Annotation</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#addannotation">addAnnotation</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/AbstractWriter.ts#L27">src/AbstractWriter.ts:27</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/AbstractWriter.ts#L27">src/AbstractWriter.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -195,7 +195,7 @@ <h3>close</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#close">close</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/IonWriter.ts#L169">src/IonWriter.ts:169</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/IonWriter.ts#L169">src/IonWriter.ts:169</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -224,7 +224,7 @@ <h3>depth</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#depth">depth</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/IonWriter.ts#L183">src/IonWriter.ts:183</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/IonWriter.ts#L183">src/IonWriter.ts:183</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -247,7 +247,7 @@ <h3>get<wbr>Bytes</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#getbytes">getBytes</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/IonWriter.ts#L178">src/IonWriter.ts:178</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/IonWriter.ts#L178">src/IonWriter.ts:178</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -277,7 +277,7 @@ <h3>set<wbr>Annotations</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#setannotations">setAnnotations</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/AbstractWriter.ts#L34">src/AbstractWriter.ts:34</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/AbstractWriter.ts#L34">src/AbstractWriter.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -308,7 +308,7 @@ <h3>step<wbr>In</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#stepin">stepIn</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/IonWriter.ts#L141">src/IonWriter.ts:141</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/IonWriter.ts#L141">src/IonWriter.ts:141</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -343,7 +343,7 @@ <h3>step<wbr>Out</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#stepout">stepOut</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/IonWriter.ts#L148">src/IonWriter.ts:148</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/IonWriter.ts#L148">src/IonWriter.ts:148</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -371,7 +371,7 @@ <h3>write<wbr>Blob</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#writeblob">writeBlob</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/IonWriter.ts#L93">src/IonWriter.ts:93</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/IonWriter.ts#L93">src/IonWriter.ts:93</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -403,7 +403,7 @@ <h3>write<wbr>Boolean</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#writeboolean">writeBoolean</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/IonWriter.ts#L33">src/IonWriter.ts:33</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/IonWriter.ts#L33">src/IonWriter.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -435,7 +435,7 @@ <h3>write<wbr>Clob</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#writeclob">writeClob</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/IonWriter.ts#L100">src/IonWriter.ts:100</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/IonWriter.ts#L100">src/IonWriter.ts:100</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -467,7 +467,7 @@ <h3>write<wbr>Decimal</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#writedecimal">writeDecimal</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/IonWriter.ts#L65">src/IonWriter.ts:65</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/IonWriter.ts#L65">src/IonWriter.ts:65</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -499,7 +499,7 @@ <h3>write<wbr>Field<wbr>Name</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#writefieldname">writeFieldName</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/IonWriter.ts#L133">src/IonWriter.ts:133</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/IonWriter.ts#L133">src/IonWriter.ts:133</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -534,7 +534,7 @@ <h3>write<wbr>Float32</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#writefloat32">writeFloat32</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/IonWriter.ts#L51">src/IonWriter.ts:51</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/IonWriter.ts#L51">src/IonWriter.ts:51</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -568,7 +568,7 @@ <h3>write<wbr>Float64</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#writefloat64">writeFloat64</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/IonWriter.ts#L58">src/IonWriter.ts:58</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/IonWriter.ts#L58">src/IonWriter.ts:58</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -600,7 +600,7 @@ <h3>write<wbr>Int</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#writeint">writeInt</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/IonWriter.ts#L42">src/IonWriter.ts:42</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/IonWriter.ts#L42">src/IonWriter.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -634,7 +634,7 @@ <h3>write<wbr>Null</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#writenull">writeNull</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/IonWriter.ts#L26">src/IonWriter.ts:26</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/IonWriter.ts#L26">src/IonWriter.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -663,7 +663,7 @@ <h3>write<wbr>String</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#writestring">writeString</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/IonWriter.ts#L79">src/IonWriter.ts:79</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/IonWriter.ts#L79">src/IonWriter.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -695,7 +695,7 @@ <h3>write<wbr>Symbol</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#writesymbol">writeSymbol</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/IonWriter.ts#L86">src/IonWriter.ts:86</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/IonWriter.ts#L86">src/IonWriter.ts:86</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -727,7 +727,7 @@ <h3>write<wbr>Timestamp</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#writetimestamp">writeTimestamp</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/IonWriter.ts#L72">src/IonWriter.ts:72</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/IonWriter.ts#L72">src/IonWriter.ts:72</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -759,7 +759,7 @@ <h3>write<wbr>Value</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#writevalue">writeValue</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/AbstractWriter.ts#L52">src/AbstractWriter.ts:52</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/AbstractWriter.ts#L52">src/AbstractWriter.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -793,7 +793,7 @@ <h3>write<wbr>Values</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="../interfaces/ionwriter.writer.html">Writer</a>.<a href="../interfaces/ionwriter.writer.html#writevalues">writeValues</a></p>
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/AbstractWriter.ts#L48">src/AbstractWriter.ts:48</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/AbstractWriter.ts#L48">src/AbstractWriter.ts:48</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
8 changes: 4 additions & 4 deletions api/classes/bigintserde.bigintserde-1.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Unsigned<wbr>Byt
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/BigIntSerde.ts#L57">src/BigIntSerde.ts:57</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/BigIntSerde.ts#L57">src/BigIntSerde.ts:57</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -167,7 +167,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Unsigned<wbr>Int<
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/BigIntSerde.ts#L90">src/BigIntSerde.ts:90</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/BigIntSerde.ts#L90">src/BigIntSerde.ts:90</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -190,7 +190,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> to<wbr>Signed<wbr>Int<wbr
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/BigIntSerde.ts#L35">src/BigIntSerde.ts:35</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/BigIntSerde.ts#L35">src/BigIntSerde.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -229,7 +229,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> to<wbr>Unsigned<wbr>Int<w
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/BigIntSerde.ts#L72">src/BigIntSerde.ts:72</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/BigIntSerde.ts#L72">src/BigIntSerde.ts:72</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
10 changes: 5 additions & 5 deletions api/classes/comparisonresult.comparisonresult-1.html
View file
Original file line number Diff line number Diff line change
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/amzn/ion-js/blob/96a6fa5/src/ComparisonResult.ts#L34">src/ComparisonResult.ts:34</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/ComparisonResult.ts#L34">src/ComparisonResult.ts:34</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -148,7 +148,7 @@ <h3>actual<wbr>Index</h3>
<div class="tsd-signature tsd-kind-icon">actual<wbr>Index<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/amzn/ion-js/blob/96a6fa5/src/ComparisonResult.ts#L33">src/ComparisonResult.ts:33</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/ComparisonResult.ts#L33">src/ComparisonResult.ts:33</a></li>
</ul>
</aside>
</section>
Expand All @@ -158,7 +158,7 @@ <h3>expected<wbr>Index</h3>
<div class="tsd-signature tsd-kind-icon">expected<wbr>Index<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/amzn/ion-js/blob/96a6fa5/src/ComparisonResult.ts#L34">src/ComparisonResult.ts:34</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/ComparisonResult.ts#L34">src/ComparisonResult.ts:34</a></li>
</ul>
</aside>
</section>
Expand All @@ -168,7 +168,7 @@ <h3>message</h3>
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/ComparisonResult.ts#L31">src/ComparisonResult.ts:31</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/ComparisonResult.ts#L31">src/ComparisonResult.ts:31</a></li>
</ul>
</aside>
</section>
Expand All @@ -178,7 +178,7 @@ <h3>result</h3>
<div class="tsd-signature tsd-kind-icon">result<span class="tsd-signature-symbol">:</span> <a href="../enums/comparisonresult.comparisonresulttype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ComparisonResultType</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/amzn/ion-js/blob/96a6fa5/src/ComparisonResult.ts#L32">src/ComparisonResult.ts:32</a></li>
<li>Defined in <a href="https://github.com/amazon-ion/ion-js/blob/cafecdd/src/ComparisonResult.ts#L32">src/ComparisonResult.ts:32</a></li>
</ul>
</aside>
</section>
Expand Down
Loading

0 comments on commit b008bcd

Please sign in to comment.