Skip to content

Commit

Permalink
CI updated the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
MichealWayne committed Dec 24, 2024
1 parent 4b32e82 commit df7bb40
Show file tree
Hide file tree
Showing 550 changed files with 5,274 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/.nojekyll
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
1 change: 1 addition & 0 deletions docs/.typedoc-plugin-versions
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"versions":["v1.0.0-beta01"],"stable":"v1.0.0-beta01","dev":"v1.0.0-beta01"}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions docs/dev
1 change: 1 addition & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<meta http-equiv="refresh" content="0; url=stable/"/>
1 change: 1 addition & 0 deletions docs/stable
1 change: 1 addition & 0 deletions docs/v1.0
1 change: 1 addition & 0 deletions docs/v1.0.0-beta01/data/Array.Function.allEqual.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"id":301,"name":"allEqual","kind":64,"kindString":"Function","flags":{},"children":[],"sources":[{"fileName":"utils/src/array.ts","fullFileName":"/home/runner/work/fe-tools/fe-tools/utils/packages/utils/src/array.ts","line":77,"character":13,"url":"https://github.com/MichealWayne/fe-tools/blob/4b32e82/utils/packages/utils/src/array.ts#L77"}],"signatures":[{"id":302,"name":"allEqual","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@function","content":[{"kind":"text","text":"allEqual"}]},{"tag":"@description","content":[{"kind":"text","text":"判断数组中所有项是否都相等。(NaN !== NaN)"}]},{"tag":"@returns","content":[{"kind":"text","text":"是否所有项都相等, 空数组返回true"}]},{"tag":"@example","content":[{"kind":"code","text":"```ts\nallEqual([0, 1, 2]); // false\r\nallEqual([2, 2, 2]); // true\r\nallEqual([2, 2, '2']); // false\r\nallEqual([NaN, NaN, NaN]); // false\n```"}]}]},"parameters":[{"id":303,"name":"arr","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"数组"}]},"type":{"type":"reference","id":300,"name":"AnyArr"},"text":{"comment":"<p>数组</p>\n"}}],"type":{"type":"intrinsic","name":"boolean"},"is":{"declaration":false},"location":{"query":"Array.Function.allEqual","hash":"allEqual"},"text":{"comment":"<h5>Function:</h5><p>allEqual</p>\n<h5>Description:</h5><p>判断数组中所有项是否都相等。(NaN !== NaN)</p>\n<h5>Returns:</h5><p>是否所有项都相等, 空数组返回true</p>\n<h5>Example:</h5><pre><code class=\"language-ts\"><span class=\"pl-en\">allEqual</span>([<span class=\"pl-c1\">0</span>, <span class=\"pl-c1\">1</span>, <span class=\"pl-c1\">2</span>]); <span class=\"pl-c\">// false</span>\n<span class=\"pl-en\">allEqual</span>([<span class=\"pl-c1\">2</span>, <span class=\"pl-c1\">2</span>, <span class=\"pl-c1\">2</span>]); <span class=\"pl-c\">// true</span>\n<span class=\"pl-en\">allEqual</span>([<span class=\"pl-c1\">2</span>, <span class=\"pl-c1\">2</span>, <span class=\"pl-s\"><span class=\"pl-pds\">'</span>2<span class=\"pl-pds\">'</span></span>]); <span class=\"pl-c\">// false</span>\n<span class=\"pl-en\">allEqual</span>([<span class=\"pl-c1\">NaN</span>, <span class=\"pl-c1\">NaN</span>, <span class=\"pl-c1\">NaN</span>]); <span class=\"pl-c\">// false</span>\n</code></pre>\n"},"sources":[{"fileName":"utils/src/array.ts","fullFileName":"/home/runner/work/fe-tools/fe-tools/utils/packages/utils/src/array.ts","line":77,"character":24,"url":"https://github.com/MichealWayne/fe-tools/blob/4b32e82/utils/packages/utils/src/array.ts#L77"}],"parentId":301}],"is":{"declaration":true},"location":{"query":"Array.Function.allEqual","hash":""},"text":{},"parentId":154}
1 change: 1 addition & 0 deletions docs/v1.0.0-beta01/data/Array.Function.arrayAverage.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"id":161,"name":"arrayAverage","kind":64,"kindString":"Function","flags":{},"children":[],"sources":[{"fileName":"utils/src/array.ts","fullFileName":"/home/runner/work/fe-tools/fe-tools/utils/packages/utils/src/array.ts","line":49,"character":16,"url":"https://github.com/MichealWayne/fe-tools/blob/4b32e82/utils/packages/utils/src/array.ts#L49"}],"signatures":[{"id":162,"name":"arrayAverage","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@function","content":[{"kind":"text","text":"arrayAverage"}]},{"tag":"@description","content":[{"kind":"text","text":"求数组平均值"}]},{"tag":"@returns","content":[{"kind":"text","text":"数组平均值, 数组为空返回0"}]},{"tag":"@example","content":[{"kind":"code","text":"```ts\narrayMax([1, 2, 3, 0, -1, -5]); // -> 0\r\narrayMax([1, 2, 3]); // -> 2\n```"}]}]},"parameters":[{"id":163,"name":"arr","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"数字数组"}]},"type":{"type":"array","elementType":{"type":"intrinsic","name":"number"}},"text":{"comment":"<p>数字数组</p>\n"}}],"type":{"type":"intrinsic","name":"number"},"is":{"declaration":false},"location":{"query":"Array.Function.arrayAverage","hash":"arrayAverage"},"text":{"comment":"<h5>Function:</h5><p>arrayAverage</p>\n<h5>Description:</h5><p>求数组平均值</p>\n<h5>Returns:</h5><p>数组平均值, 数组为空返回0</p>\n<h5>Example:</h5><pre><code class=\"language-ts\"><span class=\"pl-en\">arrayMax</span>([<span class=\"pl-c1\">1</span>, <span class=\"pl-c1\">2</span>, <span class=\"pl-c1\">3</span>, <span class=\"pl-c1\">0</span>, <span class=\"pl-k\">-</span><span class=\"pl-c1\">1</span>, <span class=\"pl-k\">-</span><span class=\"pl-c1\">5</span>]); <span class=\"pl-c\">// -> 0</span>\n<span class=\"pl-en\">arrayMax</span>([<span class=\"pl-c1\">1</span>, <span class=\"pl-c1\">2</span>, <span class=\"pl-c1\">3</span>]); <span class=\"pl-c\">// -> 2</span>\n</code></pre>\n"},"sources":[{"fileName":"utils/src/array.ts","fullFileName":"/home/runner/work/fe-tools/fe-tools/utils/packages/utils/src/array.ts","line":49,"character":0,"url":"https://github.com/MichealWayne/fe-tools/blob/4b32e82/utils/packages/utils/src/array.ts#L49"}],"parentId":161}],"is":{"declaration":true},"location":{"query":"Array.Function.arrayAverage","hash":""},"text":{},"parentId":154}
1 change: 1 addition & 0 deletions docs/v1.0.0-beta01/data/Array.Function.arrayMax.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"id":155,"name":"arrayMax","kind":64,"kindString":"Function","flags":{},"children":[],"sources":[{"fileName":"utils/src/array.ts","fullFileName":"/home/runner/work/fe-tools/fe-tools/utils/packages/utils/src/array.ts","line":23,"character":16,"url":"https://github.com/MichealWayne/fe-tools/blob/4b32e82/utils/packages/utils/src/array.ts#L23"}],"signatures":[{"id":156,"name":"arrayMax","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@function","content":[{"kind":"text","text":"arrayMax"}]},{"tag":"@description","content":[{"kind":"text","text":"求数组最大值"}]},{"tag":"@returns","content":[{"kind":"text","text":"数组最大值, 数组为空返回-Infinity, 数组中有非数字项返回NaN"}]},{"tag":"@example","content":[{"kind":"code","text":"```ts\narrayMax([1, 2, 3, 0, -1, -5]); // -> 3\r\narrayMax([1, 2, 3]); // -> 3\n```"}]}]},"parameters":[{"id":157,"name":"arr","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"数字数组"}]},"type":{"type":"reference","id":299,"name":"NumberArr"},"text":{"comment":"<p>数字数组</p>\n"}}],"type":{"type":"intrinsic","name":"number"},"is":{"declaration":false},"location":{"query":"Array.Function.arrayMax","hash":"arrayMax"},"text":{"comment":"<h5>Function:</h5><p>arrayMax</p>\n<h5>Description:</h5><p>求数组最大值</p>\n<h5>Returns:</h5><p>数组最大值, 数组为空返回-Infinity, 数组中有非数字项返回NaN</p>\n<h5>Example:</h5><pre><code class=\"language-ts\"><span class=\"pl-en\">arrayMax</span>([<span class=\"pl-c1\">1</span>, <span class=\"pl-c1\">2</span>, <span class=\"pl-c1\">3</span>, <span class=\"pl-c1\">0</span>, <span class=\"pl-k\">-</span><span class=\"pl-c1\">1</span>, <span class=\"pl-k\">-</span><span class=\"pl-c1\">5</span>]); <span class=\"pl-c\">// -> 3</span>\n<span class=\"pl-en\">arrayMax</span>([<span class=\"pl-c1\">1</span>, <span class=\"pl-c1\">2</span>, <span class=\"pl-c1\">3</span>]); <span class=\"pl-c\">// -> 3</span>\n</code></pre>\n"},"sources":[{"fileName":"utils/src/array.ts","fullFileName":"/home/runner/work/fe-tools/fe-tools/utils/packages/utils/src/array.ts","line":23,"character":0,"url":"https://github.com/MichealWayne/fe-tools/blob/4b32e82/utils/packages/utils/src/array.ts#L23"}],"parentId":155}],"is":{"declaration":true},"location":{"query":"Array.Function.arrayMax","hash":""},"text":{},"parentId":154}
1 change: 1 addition & 0 deletions docs/v1.0.0-beta01/data/Array.Function.arrayMin.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"id":158,"name":"arrayMin","kind":64,"kindString":"Function","flags":{},"children":[],"sources":[{"fileName":"utils/src/array.ts","fullFileName":"/home/runner/work/fe-tools/fe-tools/utils/packages/utils/src/array.ts","line":36,"character":16,"url":"https://github.com/MichealWayne/fe-tools/blob/4b32e82/utils/packages/utils/src/array.ts#L36"}],"signatures":[{"id":159,"name":"arrayMin","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@function","content":[{"kind":"text","text":"arrayMin"}]},{"tag":"@description","content":[{"kind":"text","text":"求数组最小值"}]},{"tag":"@returns","content":[{"kind":"text","text":"数组最小值, 数组为空返回Infinity, 数组中有非数字项返回NaN"}]},{"tag":"@example","content":[{"kind":"code","text":"```ts\narrayMax([1, 2, 3, 0, -1, -5]); // -> -5\r\narrayMax([1, 2, 3]); // -> 1\n```"}]}]},"parameters":[{"id":160,"name":"arr","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"数字数组"}]},"type":{"type":"reference","id":299,"name":"NumberArr"},"text":{"comment":"<p>数字数组</p>\n"}}],"type":{"type":"intrinsic","name":"number"},"is":{"declaration":false},"location":{"query":"Array.Function.arrayMin","hash":"arrayMin"},"text":{"comment":"<h5>Function:</h5><p>arrayMin</p>\n<h5>Description:</h5><p>求数组最小值</p>\n<h5>Returns:</h5><p>数组最小值, 数组为空返回Infinity, 数组中有非数字项返回NaN</p>\n<h5>Example:</h5><pre><code class=\"language-ts\"><span class=\"pl-en\">arrayMax</span>([<span class=\"pl-c1\">1</span>, <span class=\"pl-c1\">2</span>, <span class=\"pl-c1\">3</span>, <span class=\"pl-c1\">0</span>, <span class=\"pl-k\">-</span><span class=\"pl-c1\">1</span>, <span class=\"pl-k\">-</span><span class=\"pl-c1\">5</span>]); <span class=\"pl-c\">// -> -5</span>\n<span class=\"pl-en\">arrayMax</span>([<span class=\"pl-c1\">1</span>, <span class=\"pl-c1\">2</span>, <span class=\"pl-c1\">3</span>]); <span class=\"pl-c\">// -> 1</span>\n</code></pre>\n"},"sources":[{"fileName":"utils/src/array.ts","fullFileName":"/home/runner/work/fe-tools/fe-tools/utils/packages/utils/src/array.ts","line":36,"character":0,"url":"https://github.com/MichealWayne/fe-tools/blob/4b32e82/utils/packages/utils/src/array.ts#L36"}],"parentId":158}],"is":{"declaration":true},"location":{"query":"Array.Function.arrayMin","hash":""},"text":{},"parentId":154}
1 change: 1 addition & 0 deletions docs/v1.0.0-beta01/data/Array.Function.arraySum.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"id":164,"name":"arraySum","kind":64,"kindString":"Function","flags":{},"children":[],"sources":[{"fileName":"utils/src/array.ts","fullFileName":"/home/runner/work/fe-tools/fe-tools/utils/packages/utils/src/array.ts","line":62,"character":16,"url":"https://github.com/MichealWayne/fe-tools/blob/4b32e82/utils/packages/utils/src/array.ts#L62"}],"signatures":[{"id":165,"name":"arraySum","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@function","content":[{"kind":"text","text":"arraySum"}]},{"tag":"@description","content":[{"kind":"text","text":"数组求和"}]},{"tag":"@returns","content":[{"kind":"text","text":"数组求和, 数组为空返回0"}]},{"tag":"@example","content":[{"kind":"code","text":"```ts\narrayMax([1, 2, 3]); // -> 6\r\narrayMax([-1, 2, 3]); // -> 4\n```"}]}]},"parameters":[{"id":166,"name":"arr","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"数字数组"}]},"type":{"type":"array","elementType":{"type":"intrinsic","name":"number"}},"text":{"comment":"<p>数字数组</p>\n"}}],"type":{"type":"intrinsic","name":"number"},"is":{"declaration":false},"location":{"query":"Array.Function.arraySum","hash":"arraySum"},"text":{"comment":"<h5>Function:</h5><p>arraySum</p>\n<h5>Description:</h5><p>数组求和</p>\n<h5>Returns:</h5><p>数组求和, 数组为空返回0</p>\n<h5>Example:</h5><pre><code class=\"language-ts\"><span class=\"pl-en\">arrayMax</span>([<span class=\"pl-c1\">1</span>, <span class=\"pl-c1\">2</span>, <span class=\"pl-c1\">3</span>]); <span class=\"pl-c\">// -> 6</span>\n<span class=\"pl-en\">arrayMax</span>([<span class=\"pl-k\">-</span><span class=\"pl-c1\">1</span>, <span class=\"pl-c1\">2</span>, <span class=\"pl-c1\">3</span>]); <span class=\"pl-c\">// -> 4</span>\n</code></pre>\n"},"sources":[{"fileName":"utils/src/array.ts","fullFileName":"/home/runner/work/fe-tools/fe-tools/utils/packages/utils/src/array.ts","line":62,"character":0,"url":"https://github.com/MichealWayne/fe-tools/blob/4b32e82/utils/packages/utils/src/array.ts#L62"}],"parentId":164}],"is":{"declaration":true},"location":{"query":"Array.Function.arraySum","hash":""},"text":{},"parentId":154}
1 change: 1 addition & 0 deletions docs/v1.0.0-beta01/data/Array.Function.arrayToCSV.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"id":170,"name":"arrayToCSV","kind":64,"kindString":"Function","flags":{},"children":[],"sources":[{"fileName":"utils/src/array.ts","fullFileName":"/home/runner/work/fe-tools/fe-tools/utils/packages/utils/src/array.ts","line":125,"character":16,"url":"https://github.com/MichealWayne/fe-tools/blob/4b32e82/utils/packages/utils/src/array.ts#L125"}],"signatures":[{"id":171,"name":"arrayToCSV","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@function","content":[{"kind":"text","text":"arrayToCSV"}]},{"tag":"@description","content":[{"kind":"text","text":"二维数据转csv字符串"}]},{"tag":"@returns","content":[{"kind":"text","text":"csv字符串"}]},{"tag":"@example","content":[{"kind":"code","text":"```ts\narrayToCSV([['a', 'b'], ['c', 'd']], ','); // '\"a\",\"b\"\\n\"c\",\"d\"'\n```"}]}]},"parameters":[{"id":172,"name":"arr","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"二维数组"}]},"type":{"type":"array","elementType":{"type":"reference","id":300,"name":"AnyArr"}},"text":{"comment":"<p>二维数组</p>\n"}},{"id":173,"name":"delimiter","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"分隔符"}]},"type":{"type":"intrinsic","name":"string"},"defaultValue":"','","text":{"comment":"<p>分隔符</p>\n"}}],"type":{"type":"intrinsic","name":"string"},"is":{"declaration":false},"location":{"query":"Array.Function.arrayToCSV","hash":"arrayToCSV"},"text":{"comment":"<h5>Function:</h5><p>arrayToCSV</p>\n<h5>Description:</h5><p>二维数据转csv字符串</p>\n<h5>Returns:</h5><p>csv字符串</p>\n<h5>Example:</h5><pre><code class=\"language-ts\"><span class=\"pl-en\">arrayToCSV</span>([[<span class=\"pl-s\"><span class=\"pl-pds\">'</span>a<span class=\"pl-pds\">'</span></span>, <span class=\"pl-s\"><span class=\"pl-pds\">'</span>b<span class=\"pl-pds\">'</span></span>], [<span class=\"pl-s\"><span class=\"pl-pds\">'</span>c<span class=\"pl-pds\">'</span></span>, <span class=\"pl-s\"><span class=\"pl-pds\">'</span>d<span class=\"pl-pds\">'</span></span>]], <span class=\"pl-s\"><span class=\"pl-pds\">'</span>,<span class=\"pl-pds\">'</span></span>); <span class=\"pl-c\">// '\"a\",\"b\"\\n\"c\",\"d\"'</span>\n</code></pre>\n"},"sources":[{"fileName":"utils/src/array.ts","fullFileName":"/home/runner/work/fe-tools/fe-tools/utils/packages/utils/src/array.ts","line":125,"character":0,"url":"https://github.com/MichealWayne/fe-tools/blob/4b32e82/utils/packages/utils/src/array.ts#L125"}],"parentId":170}],"is":{"declaration":true},"location":{"query":"Array.Function.arrayToCSV","hash":""},"text":{},"parentId":154}
1 change: 1 addition & 0 deletions docs/v1.0.0-beta01/data/Array.Function.castArray.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"id":174,"name":"castArray","kind":64,"kindString":"Function","flags":{},"children":[],"sources":[{"fileName":"utils/src/array.ts","fullFileName":"/home/runner/work/fe-tools/fe-tools/utils/packages/utils/src/array.ts","line":138,"character":16,"url":"https://github.com/MichealWayne/fe-tools/blob/4b32e82/utils/packages/utils/src/array.ts#L138"}],"signatures":[{"id":175,"name":"castArray","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@function","content":[{"kind":"text","text":"castArray"}]},{"tag":"@description","content":[{"kind":"text","text":"未知类型的数据val转数组"}]},{"tag":"@returns","content":[{"kind":"text","text":"数组"}]},{"tag":"@example","content":[{"kind":"code","text":"```ts\ncastArray('foo'); // ['foo']\r\ncastArray([1]); // [1]\n```"}]}]},"typeParameter":[{"id":176,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":177,"name":"val","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"未知类型的数据"}]},"type":{"type":"union","types":[{"type":"reference","id":176,"name":"T"},{"type":"array","elementType":{"type":"reference","id":176,"name":"T"}}]},"text":{"comment":"<p>未知类型的数据</p>\n"}}],"type":{"type":"array","elementType":{"type":"reference","id":176,"name":"T"}},"is":{"declaration":false},"location":{"query":"Array.Function.castArray","hash":"castArray"},"text":{"comment":"<h5>Function:</h5><p>castArray</p>\n<h5>Description:</h5><p>未知类型的数据val转数组</p>\n<h5>Returns:</h5><p>数组</p>\n<h5>Example:</h5><pre><code class=\"language-ts\"><span class=\"pl-en\">castArray</span>(<span class=\"pl-s\"><span class=\"pl-pds\">'</span>foo<span class=\"pl-pds\">'</span></span>); <span class=\"pl-c\">// ['foo']</span>\n<span class=\"pl-en\">castArray</span>([<span class=\"pl-c1\">1</span>]); <span class=\"pl-c\">// [1]</span>\n</code></pre>\n"},"sources":[{"fileName":"utils/src/array.ts","fullFileName":"/home/runner/work/fe-tools/fe-tools/utils/packages/utils/src/array.ts","line":138,"character":0,"url":"https://github.com/MichealWayne/fe-tools/blob/4b32e82/utils/packages/utils/src/array.ts#L138"}],"parentId":174}],"is":{"declaration":true},"location":{"query":"Array.Function.castArray","hash":""},"text":{},"parentId":154}
Loading

0 comments on commit df7bb40

Please sign in to comment.