Skip to content

Commit

Permalink
Deploying to gh-pages from @ 15ea1bc 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@kMutagene
kMutagene committed Sep 26, 2024
1 parent 694a4e2 commit d7c65bc
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 36 deletions.
6 changes: 3 additions & 3 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -245,15 +245,15 @@ <h2><a name="Serialization" class="anchor" href="#Serialization">Serialization</
<div class="fsdocs-tip" id="fs20">val tryGetTypedPropertyValue: propertyName: string -&gt; dynObj: DynamicObj -&gt; &#39;TPropertyValue option<br /><em>&lt;summary&gt;
Returns Some(&#39;TPropertyValue) when a dynamic (or static) property with the given name and type exists on the input, otherwise None.
&lt;/summary&gt;<br />&lt;param name=&quot;propertyName&quot;&gt;the name of the property to get&lt;/param&gt;<br />&lt;param name=&quot;dynObj&quot;&gt;the input DynamicObj&lt;/param&gt;</em></div>
<div class="fsdocs-tip" id="fs21">val withProperty: propertyName: string -&gt; propertyValue: &#39;TPropertyValue -&gt; dynObj: DynamicObj -&gt; DynamicObj<br /><em>&lt;summary&gt;
<div class="fsdocs-tip" id="fs21">val withProperty: propertyName: string -&gt; propertyValue: &#39;TPropertyValue -&gt; dynObj: &#39;a -&gt; &#39;a (requires &#39;a :&gt; DynamicObj)<br /><em>&lt;summary&gt;
Sets the dynamic (or static) property value with the given name, creating a new dynamic property if none exists on the given DynamicObj and returns it.
&lt;/summary&gt;<br />&lt;param name=&quot;propertyName&quot;&gt;The name of the property to set&lt;/param&gt;<br />&lt;param name=&quot;propertyValue&quot;&gt;The value of the property to set&lt;/param&gt;<br />&lt;param name=&quot;dynObj&quot;&gt;The DynamicObj to set the property on&lt;/param&gt;<br />&lt;remarks&gt;This function mutates the input DynamicObj&lt;/remarks&gt;</em></div>
<div class="fsdocs-tip" id="fs22">val withoutProperty: propertyName: string -&gt; dynObj: DynamicObj -&gt; DynamicObj<br /><em>&lt;summary&gt;
<div class="fsdocs-tip" id="fs22">val withoutProperty: propertyName: string -&gt; dynObj: &#39;a -&gt; &#39;a (requires &#39;a :&gt; DynamicObj)<br /><em>&lt;summary&gt;
Removes any dynamic property with the given name from the input DynamicObj and returns it.
If the property is static and mutable, it will be set to null.
Static immutable properties cannot be removed.
&lt;/summary&gt;<br />&lt;param name=&quot;propertyName&quot;&gt;The name of the property to remove&lt;/param&gt;<br />&lt;param name=&quot;dynObj&quot;&gt;The DynamicObj to remove the property from&lt;/param&gt;<br />&lt;remarks&gt;This function mutates the input DynamicObj&lt;/remarks&gt;<br />&lt;exception cref=&quot;System.MemberAccessException&quot;&gt;Thrown if the dynamic property does not exist&lt;/exception&gt;</em></div>
<div class="fsdocs-tip" id="fs23">val withOptionalProperty: propertyName: string -&gt; propertyValue: &#39;TPropertyValue option -&gt; dynObj: DynamicObj -&gt; DynamicObj<br /><em>&lt;summary&gt;
<div class="fsdocs-tip" id="fs23">val withOptionalProperty: propertyName: string -&gt; propertyValue: &#39;TPropertyValue option -&gt; dynObj: &#39;a -&gt; &#39;a (requires &#39;a :&gt; DynamicObj)<br /><em>&lt;summary&gt;
Sets the dynamic (or static) property value with the given name on the given DynamicObj if the value is Some(&#39;TPropertyValue), creating a new dynamic property if none exists, and returns it.
If the given propertyValue is None, does nothing to the input DynamicObj.
&lt;/summary&gt;<br />&lt;param name=&quot;propertyName&quot;&gt;The name of the property to set&lt;/param&gt;<br />&lt;param name=&quot;propertyValue&quot;&gt;The value of the property to set&lt;/param&gt;<br />&lt;param name=&quot;dynObj&quot;&gt;The DynamicObj to set the property on&lt;/param&gt;<br />&lt;remarks&gt;This function mutates the input DynamicObj&lt;/remarks&gt;</em></div>
Expand Down
2 changes: 1 addition & 1 deletion index.json
View file

Large diffs are not rendered by default.

84 changes: 52 additions & 32 deletions reference/dynamicobj-dynobj.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ <h3>
first
</b>
:
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
-

</span>
Expand All @@ -166,7 +166,7 @@ <h3>
second
</b>
:
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'b</code>
-

</span>
Expand All @@ -175,7 +175,7 @@ <h3>
<br/>
<span>
Returns:
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
</span>
<br/>
</div>
Expand All @@ -186,10 +186,10 @@ <h3>
<details>
<summary>
<div class="fsdocs-summary">
<div class="fsdocs-source-link" title="Copy signature (Markdown)" onclick="Clipboard_CopyTo('`cref:M:DynamicObj.DynObj.combine`')">
<div class="fsdocs-source-link" title="Copy signature (Markdown)" onclick="Clipboard_CopyTo('```cref:M:DynamicObj.DynObj.combine``2```')">
<iconify-icon icon="bi:filetype-md" height="24" width="24"></iconify-icon>
</div>
<div class="fsdocs-source-link" title="Copy signature (XML)" onclick="Clipboard_CopyTo('<see cref=\'M:DynamicObj.DynObj.combine\'/>')">
<div class="fsdocs-source-link" title="Copy signature (XML)" onclick="Clipboard_CopyTo('<see cref=\'M:DynamicObj.DynObj.combine``2\'/>')">
<iconify-icon icon="bi:filetype-xml" height="24" width="24"></iconify-icon>
</div>
<a href="https://github.com/CSBiology/DynamicObj/tree/master/src/DynamicObj/DynObj.fs#L53-53" class="fsdocs-source-link" title="Source on GitHub">
Expand All @@ -213,7 +213,7 @@ <h3>
first
</span>
:
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
</dt>
<dd class="fsdocs-param-docs">
<p>
Expand All @@ -225,7 +225,7 @@ <h3>
second
</span>
:
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'b</code>
</dt>
<dd class="fsdocs-param-docs">
<p>
Expand All @@ -238,7 +238,7 @@ <h3>
<span class="fsdocs-return-name">
Returns:
</span>
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
</dt>
<dd class="fsdocs-return-docs"></dd>
</dl>
Expand Down Expand Up @@ -1517,7 +1517,7 @@ <h3>
dynObj
</b>
:
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
-
The DynamicObj to set the property on
</span>
Expand All @@ -1526,9 +1526,14 @@ <h3>
<br/>
<span>
Returns:
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
</span>
<br/>
Modifiers:
inline
<br/>
Type parameters:
&#39;TPropertyValue, &#39;a
</div>
</div>
</div>
Expand All @@ -1537,10 +1542,10 @@ <h3>
<details>
<summary>
<div class="fsdocs-summary">
<div class="fsdocs-source-link" title="Copy signature (Markdown)" onclick="Clipboard_CopyTo('```cref:M:DynamicObj.DynObj.withOptionalProperty``1```')">
<div class="fsdocs-source-link" title="Copy signature (Markdown)" onclick="Clipboard_CopyTo('```cref:M:DynamicObj.DynObj.withOptionalProperty``2```')">
<iconify-icon icon="bi:filetype-md" height="24" width="24"></iconify-icon>
</div>
<div class="fsdocs-source-link" title="Copy signature (XML)" onclick="Clipboard_CopyTo('<see cref=\'M:DynamicObj.DynObj.withOptionalProperty``1\'/>')">
<div class="fsdocs-source-link" title="Copy signature (XML)" onclick="Clipboard_CopyTo('<see cref=\'M:DynamicObj.DynObj.withOptionalProperty``2\'/>')">
<iconify-icon icon="bi:filetype-xml" height="24" width="24"></iconify-icon>
</div>
<a href="https://github.com/CSBiology/DynamicObj/tree/master/src/DynamicObj/DynObj.fs#L123-123" class="fsdocs-source-link" title="Source on GitHub">
Expand Down Expand Up @@ -1587,7 +1592,7 @@ <h3>
dynObj
</span>
:
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
</dt>
<dd class="fsdocs-param-docs">
<p>
Expand All @@ -1600,7 +1605,7 @@ <h3>
<span class="fsdocs-return-name">
Returns:
</span>
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
</dt>
<dd class="fsdocs-return-docs"></dd>
</dl>
Expand Down Expand Up @@ -1662,7 +1667,7 @@ <h3>
dynObj
</b>
:
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
-
The DynamicObj to set the property on
</span>
Expand All @@ -1671,9 +1676,14 @@ <h3>
<br/>
<span>
Returns:
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
</span>
<br/>
Modifiers:
inline
<br/>
Type parameters:
&#39;TPropertyValue, &#39;UPropertyValue, &#39;a
</div>
</div>
</div>
Expand All @@ -1682,10 +1692,10 @@ <h3>
<details>
<summary>
<div class="fsdocs-summary">
<div class="fsdocs-source-link" title="Copy signature (Markdown)" onclick="Clipboard_CopyTo('```cref:M:DynamicObj.DynObj.withOptionalPropertyBy``2```')">
<div class="fsdocs-source-link" title="Copy signature (Markdown)" onclick="Clipboard_CopyTo('```cref:M:DynamicObj.DynObj.withOptionalPropertyBy``3```')">
<iconify-icon icon="bi:filetype-md" height="24" width="24"></iconify-icon>
</div>
<div class="fsdocs-source-link" title="Copy signature (XML)" onclick="Clipboard_CopyTo('<see cref=\'M:DynamicObj.DynObj.withOptionalPropertyBy``2\'/>')">
<div class="fsdocs-source-link" title="Copy signature (XML)" onclick="Clipboard_CopyTo('<see cref=\'M:DynamicObj.DynObj.withOptionalPropertyBy``3\'/>')">
<iconify-icon icon="bi:filetype-xml" height="24" width="24"></iconify-icon>
</div>
<a href="https://github.com/CSBiology/DynamicObj/tree/master/src/DynamicObj/DynObj.fs#L151-151" class="fsdocs-source-link" title="Source on GitHub">
Expand Down Expand Up @@ -1744,7 +1754,7 @@ <h3>
dynObj
</span>
:
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
</dt>
<dd class="fsdocs-param-docs">
<p>
Expand All @@ -1757,7 +1767,7 @@ <h3>
<span class="fsdocs-return-name">
Returns:
</span>
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
</dt>
<dd class="fsdocs-return-docs"></dd>
</dl>
Expand Down Expand Up @@ -1809,7 +1819,7 @@ <h3>
dynObj
</b>
:
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
-
The DynamicObj to set the property on
</span>
Expand All @@ -1818,9 +1828,14 @@ <h3>
<br/>
<span>
Returns:
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
</span>
<br/>
Modifiers:
inline
<br/>
Type parameters:
&#39;TPropertyValue, &#39;a
</div>
</div>
</div>
Expand All @@ -1829,10 +1844,10 @@ <h3>
<details>
<summary>
<div class="fsdocs-summary">
<div class="fsdocs-source-link" title="Copy signature (Markdown)" onclick="Clipboard_CopyTo('```cref:M:DynamicObj.DynObj.withProperty``1```')">
<div class="fsdocs-source-link" title="Copy signature (Markdown)" onclick="Clipboard_CopyTo('```cref:M:DynamicObj.DynObj.withProperty``2```')">
<iconify-icon icon="bi:filetype-md" height="24" width="24"></iconify-icon>
</div>
<div class="fsdocs-source-link" title="Copy signature (XML)" onclick="Clipboard_CopyTo('<see cref=\'M:DynamicObj.DynObj.withProperty``1\'/>')">
<div class="fsdocs-source-link" title="Copy signature (XML)" onclick="Clipboard_CopyTo('<see cref=\'M:DynamicObj.DynObj.withProperty``2\'/>')">
<iconify-icon icon="bi:filetype-xml" height="24" width="24"></iconify-icon>
</div>
<a href="https://github.com/CSBiology/DynamicObj/tree/master/src/DynamicObj/DynObj.fs#L98-98" class="fsdocs-source-link" title="Source on GitHub">
Expand Down Expand Up @@ -1878,7 +1893,7 @@ <h3>
dynObj
</span>
:
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
</dt>
<dd class="fsdocs-param-docs">
<p>
Expand All @@ -1891,7 +1906,7 @@ <h3>
<span class="fsdocs-return-name">
Returns:
</span>
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
</dt>
<dd class="fsdocs-return-docs"></dd>
</dl>
Expand Down Expand Up @@ -1933,7 +1948,7 @@ <h3>
dynObj
</b>
:
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
-
The DynamicObj to remove the property from
</span>
Expand All @@ -1942,9 +1957,14 @@ <h3>
<br/>
<span>
Returns:
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
</span>
<br/>
Modifiers:
inline
<br/>
Type parameters:
&#39;a
</div>
</div>
</div>
Expand All @@ -1953,10 +1973,10 @@ <h3>
<details>
<summary>
<div class="fsdocs-summary">
<div class="fsdocs-source-link" title="Copy signature (Markdown)" onclick="Clipboard_CopyTo('`cref:M:DynamicObj.DynObj.withoutProperty`')">
<div class="fsdocs-source-link" title="Copy signature (Markdown)" onclick="Clipboard_CopyTo('```cref:M:DynamicObj.DynObj.withoutProperty``1```')">
<iconify-icon icon="bi:filetype-md" height="24" width="24"></iconify-icon>
</div>
<div class="fsdocs-source-link" title="Copy signature (XML)" onclick="Clipboard_CopyTo('<see cref=\'M:DynamicObj.DynObj.withoutProperty\'/>')">
<div class="fsdocs-source-link" title="Copy signature (XML)" onclick="Clipboard_CopyTo('<see cref=\'M:DynamicObj.DynObj.withoutProperty``1\'/>')">
<iconify-icon icon="bi:filetype-xml" height="24" width="24"></iconify-icon>
</div>
<a href="https://github.com/CSBiology/DynamicObj/tree/master/src/DynamicObj/DynObj.fs#L185-185" class="fsdocs-source-link" title="Source on GitHub">
Expand Down Expand Up @@ -1992,7 +2012,7 @@ <h3>
dynObj
</span>
:
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
</dt>
<dd class="fsdocs-param-docs">
<p>
Expand All @@ -2005,7 +2025,7 @@ <h3>
<span class="fsdocs-return-name">
Returns:
</span>
<code><a href="https://csbiology.github.io/DynamicObj/reference/dynamicobj-dynamicobj.html">DynamicObj</a></code>
<code>'a</code>
</dt>
<dd class="fsdocs-return-docs"></dd>
</dl>
Expand Down

0 comments on commit d7c65bc

Please sign in to comment.