Skip to content

Commit

Permalink
Added input value check on immutability
Browse files Browse the repository at this point in the history
  • Loading branch information
@ziflex
ziflex committed Aug 24, 2018
1 parent bb707a9 commit 9de06df
Show file tree
Hide file tree
Showing 18 changed files with 518 additions and 31 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# CHANGELOG

## 1.1.0

### Added
* Type check for passed immutabled structures as values.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions docs/globals.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ <h3>External modules</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-external-module"><a href="modules/_compose_.html" class="tsd-kind-icon">"compose"</a></li>
<li class="tsd-kind-external-module"><a href="modules/_index_.html" class="tsd-kind-icon">"index"</a></li>
<li class="tsd-kind-external-module"><a href="modules/_is_immutable_.html" class="tsd-kind-icon">"is-<wbr>immutable"</a></li>
</ul>
</section>
</div>
Expand All @@ -90,6 +91,9 @@ <h3>External modules</h3>
<li class=" tsd-kind-external-module">
<a href="modules/_index_.html">"index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_is_immutable_.html">"is-<wbr>immutable"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
Expand Down
3 changes: 3 additions & 0 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,9 @@ <h2 id="item-types">Item types</h2>
<li class=" tsd-kind-external-module">
<a href="modules/_index_.html">"index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_is_immutable_.html">"is-<wbr>immutable"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
Expand Down
11 changes: 7 additions & 4 deletions docs/interfaces/_compose_.class.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/caca8bb/src/compose.ts#L144">compose.ts:144</a></li>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/bb707a9/src/compose.ts#L154">compose.ts:154</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -174,7 +174,7 @@ <h3>name</h3>
<div class="tsd-signature tsd-kind-icon">name<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/ziflex/compose-record/blob/caca8bb/src/compose.ts#L144">compose.ts:144</a></li>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/bb707a9/src/compose.ts#L154">compose.ts:154</a></li>
</ul>
</aside>
</section>
Expand All @@ -191,7 +191,7 @@ <h3>create<wbr>Property<wbr>Instance</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/caca8bb/src/compose.ts#L147">compose.ts:147</a></li>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/bb707a9/src/compose.ts#L157">compose.ts:157</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -229,7 +229,7 @@ <h3>get<wbr>Property<wbr>Descriptors</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/caca8bb/src/compose.ts#L146">compose.ts:146</a></li>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/bb707a9/src/compose.ts#L156">compose.ts:156</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></h4>
Expand All @@ -250,6 +250,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Readonly<
<li class=" tsd-kind-external-module">
<a href="../modules/_index_.html">"index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_is_immutable_.html">"is-<wbr>immutable"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
Expand Down
9 changes: 6 additions & 3 deletions docs/interfaces/_compose_.composeoptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> extends</h3>
<div class="tsd-signature tsd-kind-icon">extends<span class="tsd-signature-symbol">:</span> <a href="../modules/_compose_.html#type" class="tsd-signature-type">Type</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_compose_.html#type" class="tsd-signature-type">Type</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/caca8bb/src/compose.ts#L206">compose.ts:206</a></li>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/bb707a9/src/compose.ts#L216">compose.ts:216</a></li>
</ul>
</aside>
</section>
Expand All @@ -136,7 +136,7 @@ <h3>name</h3>
<div class="tsd-signature tsd-kind-icon">name<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/ziflex/compose-record/blob/caca8bb/src/compose.ts#L204">compose.ts:204</a></li>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/bb707a9/src/compose.ts#L214">compose.ts:214</a></li>
</ul>
</aside>
</section>
Expand All @@ -146,7 +146,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> properties</h3>
<div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <a href="../modules/_compose_.html#propertycollection" class="tsd-signature-type">PropertyCollection</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/caca8bb/src/compose.ts#L205">compose.ts:205</a></li>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/bb707a9/src/compose.ts#L215">compose.ts:215</a></li>
</ul>
</aside>
</section>
Expand All @@ -164,6 +164,9 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> properties</h3>
<li class=" tsd-kind-external-module">
<a href="../modules/_index_.html">"index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_is_immutable_.html">"is-<wbr>immutable"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
Expand Down
3 changes: 3 additions & 0 deletions docs/interfaces/_compose_.immutable.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1288,6 +1288,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Map</span
<li class=" tsd-kind-external-module">
<a href="../modules/_index_.html">"index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_is_immutable_.html">"is-<wbr>immutable"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
Expand Down
11 changes: 7 additions & 4 deletions docs/interfaces/_compose_.property.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> default<wbr>Value</h3
<aside class="tsd-sources">
<p>Inherited from <a href="_compose_.typedescriptor.html">TypeDescriptor</a>.<a href="_compose_.typedescriptor.html#defaultvalue">defaultValue</a></p>
<ul>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/caca8bb/src/compose.ts#L177">compose.ts:177</a></li>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/bb707a9/src/compose.ts#L187">compose.ts:187</a></li>
</ul>
</aside>
</section>
Expand All @@ -138,7 +138,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> items</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_compose_.typedescriptor.html">TypeDescriptor</a>.<a href="_compose_.typedescriptor.html#items">items</a></p>
<ul>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/caca8bb/src/compose.ts#L178">compose.ts:178</a></li>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/bb707a9/src/compose.ts#L188">compose.ts:188</a></li>
</ul>
</aside>
</section>
Expand All @@ -148,7 +148,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> nullable</h3>
<div class="tsd-signature tsd-kind-icon">nullable<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/ziflex/compose-record/blob/caca8bb/src/compose.ts#L186">compose.ts:186</a></li>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/bb707a9/src/compose.ts#L196">compose.ts:196</a></li>
</ul>
</aside>
</section>
Expand All @@ -159,7 +159,7 @@ <h3>type</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_compose_.typedescriptor.html">TypeDescriptor</a>.<a href="_compose_.typedescriptor.html#type">type</a></p>
<ul>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/caca8bb/src/compose.ts#L176">compose.ts:176</a></li>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/bb707a9/src/compose.ts#L186">compose.ts:186</a></li>
</ul>
</aside>
</section>
Expand All @@ -177,6 +177,9 @@ <h3>type</h3>
<li class=" tsd-kind-external-module">
<a href="../modules/_index_.html">"index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_is_immutable_.html">"is-<wbr>immutable"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
Expand Down
9 changes: 6 additions & 3 deletions docs/interfaces/_compose_.typedescriptor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> default<wbr>Value</h3
<div class="tsd-signature tsd-kind-icon">default<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/caca8bb/src/compose.ts#L177">compose.ts:177</a></li>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/bb707a9/src/compose.ts#L187">compose.ts:187</a></li>
</ul>
</aside>
</section>
Expand All @@ -141,7 +141,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> items</h3>
<div class="tsd-signature tsd-kind-icon">items<span class="tsd-signature-symbol">:</span> <a href="_compose_.typedescriptor.html" class="tsd-signature-type">TypeDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/caca8bb/src/compose.ts#L178">compose.ts:178</a></li>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/bb707a9/src/compose.ts#L188">compose.ts:188</a></li>
</ul>
</aside>
</section>
Expand All @@ -151,7 +151,7 @@ <h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules/_compose_.html#type" class="tsd-signature-type">Type</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/caca8bb/src/compose.ts#L176">compose.ts:176</a></li>
<li>Defined in <a href="https://github.com/ziflex/compose-record/blob/bb707a9/src/compose.ts#L186">compose.ts:186</a></li>
</ul>
</aside>
</section>
Expand All @@ -169,6 +169,9 @@ <h3>type</h3>
<li class=" tsd-kind-external-module">
<a href="../modules/_index_.html">"index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_is_immutable_.html">"is-<wbr>immutable"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
Expand Down
3 changes: 3 additions & 0 deletions docs/interfaces/_compose_.values.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,9 @@ <h3 class="tsd-before-signature">Indexable</h3>
<li class=" tsd-kind-external-module">
<a href="../modules/_index_.html">"index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_is_immutable_.html">"is-<wbr>immutable"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
Expand Down
Loading

0 comments on commit 9de06df

Please sign in to comment.