Skip to content

Commit

Permalink
docs: Updated API
Browse files Browse the repository at this point in the history
  • Loading branch information
@bennycode
bennycode committed May 8, 2024
1 parent 3ad1b49 commit 4e1b679
Show file tree
Hide file tree
Showing 91 changed files with 4,254 additions and 913 deletions.
36 changes: 21 additions & 15 deletions docs/assets/main.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -351,12 +351,12 @@
j =
/^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/,
$ = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/,
N = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/,
V = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/,
q = /^(.+?)(s|t)(ion)$/,
C = /^(.+?)e$/,
z = /ll$/,
W = new RegExp('^' + s + i + '[^aeiouwxy]$'),
V = function (c) {
N = function (c) {
var v, P, T, h, x, O, M;
if (c.length < 3) return c;
if (
Expand Down Expand Up @@ -398,7 +398,7 @@
var E = h.exec(c);
(v = E[1]), (P = E[2]), (h = y), h.test(v) && (c = v + n[P]);
}
if (((h = N), (x = q), h.test(c))) {
if (((h = V), (x = q), h.test(c))) {
var E = h.exec(c);
(v = E[1]), (h = p), h.test(v) && (c = v);
} else if (x.test(c)) {
Expand All @@ -418,7 +418,7 @@
);
};
return function (R) {
return R.update(V);
return R.update(N);
};
})()),
t.Pipeline.registerFunction(t.stemmer, 'stemmer');
Expand Down Expand Up @@ -772,8 +772,8 @@
}),
!s[j])
) {
for (var N = 0; N < A.length; N++) {
var q = A[N],
for (var V = 0; V < A.length; V++) {
var q = A[V],
C = new t.FieldRef(q, m),
z = B[q],
W;
Expand All @@ -789,9 +789,9 @@
o[m] = o[m].intersect(y);
}
}
for (var V = t.Set.complete, R = t.Set.empty, l = 0; l < this.fields.length; l++) {
for (var N = t.Set.complete, R = t.Set.empty, l = 0; l < this.fields.length; l++) {
var m = this.fields[l];
o[m] && (V = V.intersect(o[m])), a[m] && (R = R.union(a[m]));
o[m] && (N = N.intersect(o[m])), a[m] && (R = R.union(a[m]));
}
var c = Object.keys(r),
v = [],
Expand All @@ -807,7 +807,7 @@
for (var l = 0; l < c.length; l++) {
var T = t.FieldRef.fromString(c[l]),
h = T.docRef;
if (V.contains(h) && !R.contains(h)) {
if (N.contains(h) && !R.contains(h)) {
var x = this.fieldVectors[T],
O = i[T.fieldName].similarity(x),
M;
Expand Down Expand Up @@ -1383,7 +1383,8 @@
this.ensureFocusedElementVisible(),
this.listenForCodeCopies(),
window.addEventListener('hashchange', () => this.ensureFocusedElementVisible()),
document.body.style.display || (this.scrollToHash(), this.updateIndexVisibility());
document.body.style.display ||
(this.ensureFocusedElementVisible(), this.updateIndexVisibility(), this.scrollToHash());
}
createComponents(e) {
re.forEach(n => {
Expand All @@ -1397,10 +1398,15 @@
}
showPage() {
document.body.style.display &&
(document.body.style.removeProperty('display'), this.scrollToHash(), this.updateIndexVisibility());
(console.log('Show page'),
document.body.style.removeProperty('display'),
this.ensureFocusedElementVisible(),
this.updateIndexVisibility(),
this.scrollToHash());
}
scrollToHash() {
if (location.hash) {
console.log('Scorlling');
let e = document.getElementById(location.hash.substring(1));
if (!e) return;
e.scrollIntoView({behavior: 'instant', block: 'start'});
Expand Down Expand Up @@ -1513,14 +1519,14 @@
n.addEventListener(
'input',
ie(() => {
Ne(t, e, n, r);
Ve(t, e, n, r);
}, 200)
);
let i = !1;
n.addEventListener('keydown', s => {
(i = !0),
s.key == 'Enter'
? Ve(e, n)
? Ne(e, n)
: s.key == 'Escape'
? n.blur()
: s.key == 'ArrowUp'
Expand All @@ -1539,7 +1545,7 @@
(!n.matches(':focus') && s.key === '/' && (n.focus(), s.preventDefault()));
});
}
function Ne(t, e, n, r) {
function Ve(t, e, n, r) {
if (!r.index || !r.data) return;
e.textContent = '';
let i = n.value.trim(),
Expand Down Expand Up @@ -1593,7 +1599,7 @@
r && (n.classList.remove('current'), r.classList.add('current'));
}
}
function Ve(t, e) {
function Ne(t, e) {
let n = t.querySelector('.current');
if ((n || (n = t.querySelector('li:first-child')), n)) {
let r = n.querySelector('a');
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/search.js
View file

Large diffs are not rendered by default.

9 changes: 3 additions & 6 deletions docs/assets/style.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -319,17 +319,14 @@ dd {
}

/* Footer */
.tsd-generator {
footer {
border-top: 1px solid var(--color-accent);
padding-top: 1rem;
padding-bottom: 1rem;
max-height: 3.5rem;
}

.tsd-generator > p {
margin-top: 0;
margin-bottom: 0;
padding: 0 1rem;
.tsd-generator {
margin: 0 1em;
}

.container-main {
Expand Down
122 changes: 106 additions & 16 deletions docs/classes/AC.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,10 @@ <h4>Hierarchy (<a class="link" href="../hierarchy.html#AC">view full</a>)</h4>
<ul>
<li>
Defined in
<a href="https://github.com/bennycode/trading-signals/blob/5931655/src/AC/AC.ts#L20">AC/AC.ts:20</a>
<a
href="https://github.com/bennycode/trading-signals/blob/3ad1b4924ae2dd3e505099adb87bea9a11bea99e/src/AC/AC.ts#L20"
>AC/AC.ts:20</a
>
</li>
</ul>
</aside>
Expand Down Expand Up @@ -179,6 +182,11 @@ <h3 class="tsd-index-heading">Methods</h3>
<use href="../assets/icons.svg#icon-2048"></use></svg
><span>get<wbr />Result</span></a
>
<a href="AC.html#replace" class="tsd-index-link tsd-is-inherited"
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
<use href="../assets/icons.svg#icon-2048"></use></svg
><span>replace</span></a
>
<a href="AC.html#update" class="tsd-index-link"
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
<use href="../assets/icons.svg#icon-2048"></use></svg
Expand Down Expand Up @@ -249,7 +257,8 @@ <h4 class="tsd-returns-title">
<ul>
<li>
Defined in
<a href="https://github.com/bennycode/trading-signals/blob/5931655/src/AC/AC.ts#L25"
<a
href="https://github.com/bennycode/trading-signals/blob/3ad1b4924ae2dd3e505099adb87bea9a11bea99e/src/AC/AC.ts#L25"
>AC/AC.ts:25</a
>
</li>
Expand Down Expand Up @@ -277,7 +286,10 @@ <h3 class="tsd-anchor-link">
<ul>
<li>
Defined in
<a href="https://github.com/bennycode/trading-signals/blob/5931655/src/AC/AC.ts#L21">AC/AC.ts:21</a>
<a
href="https://github.com/bennycode/trading-signals/blob/3ad1b4924ae2dd3e505099adb87bea9a11bea99e/src/AC/AC.ts#L21"
>AC/AC.ts:21</a
>
</li>
</ul>
</aside>
Expand All @@ -304,7 +316,8 @@ <h3 class="tsd-anchor-link">
<ul>
<li>
Defined in
<a href="https://github.com/bennycode/trading-signals/blob/5931655/src/Indicator.ts#L23"
<a
href="https://github.com/bennycode/trading-signals/blob/3ad1b4924ae2dd3e505099adb87bea9a11bea99e/src/Indicator.ts#L23"
>Indicator.ts:23</a
>
</li>
Expand All @@ -327,7 +340,10 @@ <h3 class="tsd-anchor-link">
<ul>
<li>
Defined in
<a href="https://github.com/bennycode/trading-signals/blob/5931655/src/AC/AC.ts#L27">AC/AC.ts:27</a>
<a
href="https://github.com/bennycode/trading-signals/blob/3ad1b4924ae2dd3e505099adb87bea9a11bea99e/src/AC/AC.ts#L27"
>AC/AC.ts:27</a
>
</li>
</ul>
</aside>
Expand All @@ -354,7 +370,8 @@ <h3 class="tsd-anchor-link">
<ul>
<li>
Defined in
<a href="https://github.com/bennycode/trading-signals/blob/5931655/src/Indicator.ts#L26"
<a
href="https://github.com/bennycode/trading-signals/blob/3ad1b4924ae2dd3e505099adb87bea9a11bea99e/src/Indicator.ts#L26"
>Indicator.ts:26</a
>
</li>
Expand All @@ -377,7 +394,10 @@ <h3 class="tsd-anchor-link">
<ul>
<li>
Defined in
<a href="https://github.com/bennycode/trading-signals/blob/5931655/src/AC/AC.ts#L22">AC/AC.ts:22</a>
<a
href="https://github.com/bennycode/trading-signals/blob/3ad1b4924ae2dd3e505099adb87bea9a11bea99e/src/AC/AC.ts#L22"
>AC/AC.ts:22</a
>
</li>
</ul>
</aside>
Expand All @@ -398,7 +418,10 @@ <h3 class="tsd-anchor-link">
<ul>
<li>
Defined in
<a href="https://github.com/bennycode/trading-signals/blob/5931655/src/AC/AC.ts#L26">AC/AC.ts:26</a>
<a
href="https://github.com/bennycode/trading-signals/blob/3ad1b4924ae2dd3e505099adb87bea9a11bea99e/src/AC/AC.ts#L26"
>AC/AC.ts:26</a
>
</li>
</ul>
</aside>
Expand All @@ -419,7 +442,10 @@ <h3 class="tsd-anchor-link">
<ul>
<li>
Defined in
<a href="https://github.com/bennycode/trading-signals/blob/5931655/src/AC/AC.ts#L23">AC/AC.ts:23</a>
<a
href="https://github.com/bennycode/trading-signals/blob/3ad1b4924ae2dd3e505099adb87bea9a11bea99e/src/AC/AC.ts#L23"
>AC/AC.ts:23</a
>
</li>
</ul>
</aside>
Expand All @@ -440,7 +466,10 @@ <h3 class="tsd-anchor-link">
<ul>
<li>
Defined in
<a href="https://github.com/bennycode/trading-signals/blob/5931655/src/AC/AC.ts#L28">AC/AC.ts:28</a>
<a
href="https://github.com/bennycode/trading-signals/blob/3ad1b4924ae2dd3e505099adb87bea9a11bea99e/src/AC/AC.ts#L28"
>AC/AC.ts:28</a
>
</li>
</ul>
</aside>
Expand Down Expand Up @@ -469,7 +498,8 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</
<ul>
<li>
Defined in
<a href="https://github.com/bennycode/trading-signals/blob/5931655/src/Indicator.ts#L31"
<a
href="https://github.com/bennycode/trading-signals/blob/3ad1b4924ae2dd3e505099adb87bea9a11bea99e/src/Indicator.ts#L31"
>Indicator.ts:31</a
>
</li>
Expand Down Expand Up @@ -511,7 +541,8 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Big</span
<ul>
<li>
Defined in
<a href="https://github.com/bennycode/trading-signals/blob/5931655/src/Indicator.ts#L35"
<a
href="https://github.com/bennycode/trading-signals/blob/3ad1b4924ae2dd3e505099adb87bea9a11bea99e/src/Indicator.ts#L35"
>Indicator.ts:35</a
>
</li>
Expand All @@ -520,6 +551,61 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Big</span
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-is-inherited">
<a id="replace" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
<span>replace</span
><a href="#replace" aria-label="Permalink" class="tsd-anchor-icon"
><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg
></a>
</h3>
<ul class="tsd-signatures tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link">
<a id="replace.replace-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">replace</span
><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span
><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span
><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span
><span class="tsd-signature-type">Big</span
><a href="#replace.replace-1" aria-label="Permalink" class="tsd-anchor-icon"
><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg
></a>
</li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<span
><span class="tsd-kind-parameter">input</span>:
<a href="../types/HighLow.html" class="tsd-signature-type tsd-kind-type-alias">HighLow</a></span
>
</li>
</ul>
</div>
<h4 class="tsd-returns-title">
Returns <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span
><span class="tsd-signature-type">Big</span>
</h4>
<aside class="tsd-sources">
<p>
Inherited from <a href="BigIndicatorSeries.html">BigIndicatorSeries</a>.<a
href="BigIndicatorSeries.html#replace"
>replace</a
>
</p>
<ul>
<li>
Defined in
<a
href="https://github.com/bennycode/trading-signals/blob/3ad1b4924ae2dd3e505099adb87bea9a11bea99e/src/Indicator.ts#L79"
>Indicator.ts:79</a
>
</li>
</ul>
</aside>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member">
<a id="update" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link">
Expand Down Expand Up @@ -572,7 +658,8 @@ <h4 class="tsd-returns-title">
<ul>
<li>
Defined in
<a href="https://github.com/bennycode/trading-signals/blob/5931655/src/AC/AC.ts#L36"
<a
href="https://github.com/bennycode/trading-signals/blob/3ad1b4924ae2dd3e505099adb87bea9a11bea99e/src/AC/AC.ts#L36"
>AC/AC.ts:36</a
>
</li>
Expand Down Expand Up @@ -680,6 +767,9 @@ <h3>
><a href="#getResult" class="tsd-is-inherited"
><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg
><span>get<wbr />Result</span></a
><a href="#replace" class="tsd-is-inherited"
><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg
><span>replace</span></a
><a href="#update" class=""
><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg
><span>update</span></a
Expand All @@ -700,9 +790,9 @@ <h3>
</div>
</div>
</div>
<div class="tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<footer>
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</footer>
<div class="overlay"></div>
</body>
</html>
Loading

0 comments on commit 4e1b679

Please sign in to comment.