Skip to content

Commit

Permalink
chore(docs): Updated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@Spiralis
Spiralis committed Nov 5, 2018
1 parent 9d01cdb commit dace7c0
Show file tree
Hide file tree
Showing 5 changed files with 150 additions and 74 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions docs/classes/categorize.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ <h3>categorization<wbr>Type<wbr>Changed</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#categorizationtypechanged">categorizationTypeChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L118">Categorize/Categorize.ts:118</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L121">Categorize/Categorize.ts:121</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -283,7 +283,7 @@ <h3>client<wbr>Categories<wbr>Update</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L107">Categorize/Categorize.ts:107</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L110">Categorize/Categorize.ts:110</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -307,7 +307,7 @@ <h3>client<wbr>IdChanged</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#clientidchanged">clientIdChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L130">Categorize/Categorize.ts:130</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L133">Categorize/Categorize.ts:133</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -333,7 +333,7 @@ <h3>create<wbr>Category<wbr>Filter</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L231">Categorize/Categorize.ts:231</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L234">Categorize/Categorize.ts:234</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -373,7 +373,7 @@ <h3>date<wbr>From<wbr>Changed</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#datefromchanged">dateFromChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L139">Categorize/Categorize.ts:139</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L142">Categorize/Categorize.ts:142</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -400,7 +400,7 @@ <h3>date<wbr>ToChanged</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#datetochanged">dateToChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L148">Categorize/Categorize.ts:148</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L151">Categorize/Categorize.ts:151</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -504,7 +504,7 @@ <h3>filters<wbr>Changed</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#filterschanged">filtersChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L157">Categorize/Categorize.ts:157</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L160">Categorize/Categorize.ts:160</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -530,7 +530,7 @@ <h3>find<wbr>Category</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L280">Categorize/Categorize.ts:280</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L283">Categorize/Categorize.ts:283</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -760,7 +760,7 @@ <h3>query<wbr>Text<wbr>Changed</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#querytextchanged">queryTextChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L166">Categorize/Categorize.ts:166</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L169">Categorize/Categorize.ts:169</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -819,7 +819,7 @@ <h3>search<wbr>Type<wbr>Changed</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#searchtypechanged">searchTypeChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L197">Categorize/Categorize.ts:197</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L200">Categorize/Categorize.ts:200</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -873,7 +873,7 @@ <h3>ui<wbr>Language<wbr>Code<wbr>Changed</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#uilanguagecodechanged">uiLanguageCodeChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L206">Categorize/Categorize.ts:206</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Categorize/Categorize.ts#L209">Categorize/Categorize.ts:209</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
26 changes: 13 additions & 13 deletions docs/classes/find.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ <h3>client<wbr>IdChanged</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#clientidchanged">clientIdChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L93">Find/Find.ts:93</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L96">Find/Find.ts:96</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -286,7 +286,7 @@ <h3>date<wbr>From<wbr>Changed</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#datefromchanged">dateFromChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L102">Find/Find.ts:102</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L105">Find/Find.ts:105</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -313,7 +313,7 @@ <h3>date<wbr>ToChanged</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#datetochanged">dateToChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L111">Find/Find.ts:111</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L114">Find/Find.ts:114</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -418,7 +418,7 @@ <h3>filters<wbr>Changed</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#filterschanged">filtersChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L120">Find/Find.ts:120</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L123">Find/Find.ts:123</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -445,7 +445,7 @@ <h3>match<wbr>Generate<wbr>Content<wbr>Changed</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#matchgeneratecontentchanged">matchGenerateContentChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L129">Find/Find.ts:129</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L132">Find/Find.ts:132</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -472,7 +472,7 @@ <h3>match<wbr>Generate<wbr>Content<wbr>Highlights<wbr>Changed</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#matchgeneratecontenthighlightschanged">matchGenerateContentHighlightsChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L138">Find/Find.ts:138</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L141">Find/Find.ts:141</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -499,7 +499,7 @@ <h3>match<wbr>Grouping<wbr>Changed</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#matchgroupingchanged">matchGroupingChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L153">Find/Find.ts:153</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L156">Find/Find.ts:156</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -526,7 +526,7 @@ <h3>match<wbr>Order<wbr>ByChanged</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#matchorderbychanged">matchOrderByChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L162">Find/Find.ts:162</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L165">Find/Find.ts:165</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -553,7 +553,7 @@ <h3>match<wbr>Page<wbr>Changed</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#matchpagechanged">matchPageChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L171">Find/Find.ts:171</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L174">Find/Find.ts:174</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -580,7 +580,7 @@ <h3>match<wbr>Page<wbr>Size<wbr>Changed</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#matchpagesizechanged">matchPageSizeChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L180">Find/Find.ts:180</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L183">Find/Find.ts:183</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -634,7 +634,7 @@ <h3>query<wbr>Text<wbr>Changed</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#querytextchanged">queryTextChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L189">Find/Find.ts:189</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L192">Find/Find.ts:192</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -693,7 +693,7 @@ <h3>search<wbr>Type<wbr>Changed</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#searchtypechanged">searchTypeChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L220">Find/Find.ts:220</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L223">Find/Find.ts:223</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -747,7 +747,7 @@ <h3>ui<wbr>Language<wbr>Code<wbr>Changed</h3>
<aside class="tsd-sources">
<p>Overrides <a href="basecall.html">BaseCall</a>.<a href="basecall.html#uilanguagecodechanged">uiLanguageCodeChanged</a></p>
<ul>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L229">Find/Find.ts:229</a></li>
<li>Defined in <a href="https://github.com/IntelliSearch/search-client/blob/master/src/Find/Find.ts#L232">Find/Find.ts:232</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
Loading

0 comments on commit dace7c0

Please sign in to comment.