Skip to content

Commit 549b8eb

Browse files
committed
docs: update docs
1 parent 8bd6bf0 commit 549b8eb

File tree

68 files changed

+38
-6264
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+38
-6264
lines changed

docs/Exception.html renamed to docs/exception/0.0.0/Exception.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ <h4 class="name" id="Exception"><span class="type-signature"></span>new Exceptio
8080

8181
<dt class="tag-source">Source:</dt>
8282
<dd class="tag-source"><ul class="dummy"><li>
83-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line347">line 347</a>
83+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line354">line 354</a>
8484
</li></ul></dd>
8585

8686

@@ -288,7 +288,7 @@ <h4 class="name" id="toString"><span class="type-signature"></span>toString<span
288288

289289
<dt class="tag-source">Source:</dt>
290290
<dd class="tag-source"><ul class="dummy"><li>
291-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line354">line 354</a>
291+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line361">line 361</a>
292292
</li></ul></dd>
293293

294294

@@ -395,7 +395,7 @@ <h5 class="h5-returns">Returns:</h5>
395395
<br class="clear">
396396

397397
<footer>
398-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Sun Apr 28 2024 19:27:34 GMT+0800 (中国标准时间) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
398+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 29 2024 03:52:56 GMT+0800 (中国标准时间) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
399399
</footer>
400400

401401
<script>prettyPrint();</script>

docs/PaletteError.html renamed to docs/exception/0.0.0/PaletteError.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ <h4 class="name" id="PaletteError"><span class="type-signature"></span>new Palet
8080

8181
<dt class="tag-source">Source:</dt>
8282
<dd class="tag-source"><ul class="dummy"><li>
83-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line82">line 82</a>
83+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line89">line 89</a>
8484
</li></ul></dd>
8585

8686

@@ -239,7 +239,7 @@ <h4 class="name" id="factory"><span class="type-signature type-signature-private
239239

240240
<dt class="tag-source">Source:</dt>
241241
<dd class="tag-source"><ul class="dummy"><li>
242-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line119">line 119</a>
242+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line126">line 126</a>
243243
</li></ul></dd>
244244

245245

@@ -441,7 +441,7 @@ <h4 class="name" id="palette"><span class="type-signature"></span>palette<span c
441441

442442
<dt class="tag-source">Source:</dt>
443443
<dd class="tag-source"><ul class="dummy"><li>
444-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line92">line 92</a>
444+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line99">line 99</a>
445445
</li></ul></dd>
446446

447447

@@ -659,7 +659,7 @@ <h5 class="h5-returns">Returns:</h5>
659659
<br class="clear">
660660

661661
<footer>
662-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Sun Apr 28 2024 19:27:34 GMT+0800 (中国标准时间) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
662+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 29 2024 03:52:56 GMT+0800 (中国标准时间) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
663663
</footer>
664664

665665
<script>prettyPrint();</script>

docs/PrintError.html renamed to docs/exception/0.0.0/PrintError.html

+8-8
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ <h4 class="name" id="PrintError"><span class="type-signature"></span>new PrintEr
8080

8181
<dt class="tag-source">Source:</dt>
8282
<dd class="tag-source"><ul class="dummy"><li>
83-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line241">line 241</a>
83+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line248">line 248</a>
8484
</li></ul></dd>
8585

8686

@@ -266,7 +266,7 @@ <h4 class="name" id="calc"><span class="type-signature type-signature-private">(
266266

267267
<dt class="tag-source">Source:</dt>
268268
<dd class="tag-source"><ul class="dummy"><li>
269-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line312">line 312</a>
269+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line319">line 319</a>
270270
</li></ul></dd>
271271

272272

@@ -480,7 +480,7 @@ <h4 class="name" id="closing"><span class="type-signature type-signature-private
480480

481481
<dt class="tag-source">Source:</dt>
482482
<dd class="tag-source"><ul class="dummy"><li>
483-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line297">line 297</a>
483+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line304">line 304</a>
484484
</li></ul></dd>
485485

486486

@@ -641,7 +641,7 @@ <h4 class="name" id="divide"><span class="type-signature type-signature-private"
641641

642642
<dt class="tag-source">Source:</dt>
643643
<dd class="tag-source"><ul class="dummy"><li>
644-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line334">line 334</a>
644+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line341">line 341</a>
645645
</li></ul></dd>
646646

647647

@@ -855,7 +855,7 @@ <h4 class="name" id="highlight"><span class="type-signature type-signature-priva
855855

856856
<dt class="tag-source">Source:</dt>
857857
<dd class="tag-source"><ul class="dummy"><li>
858-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line324">line 324</a>
858+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line331">line 331</a>
859859
</li></ul></dd>
860860

861861

@@ -1037,7 +1037,7 @@ <h4 class="name" id="opening"><span class="type-signature type-signature-private
10371037

10381038
<dt class="tag-source">Source:</dt>
10391039
<dd class="tag-source"><ul class="dummy"><li>
1040-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line253">line 253</a>
1040+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line260">line 260</a>
10411041
</li></ul></dd>
10421042

10431043

@@ -1145,7 +1145,7 @@ <h4 class="name" id="print"><span class="type-signature type-signature-private">
11451145

11461146
<dt class="tag-source">Source:</dt>
11471147
<dd class="tag-source"><ul class="dummy"><li>
1148-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line267">line 267</a>
1148+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line274">line 274</a>
11491149
</li></ul></dd>
11501150

11511151

@@ -1302,7 +1302,7 @@ <h5 class="h5-returns">Returns:</h5>
13021302
<br class="clear">
13031303

13041304
<footer>
1305-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Sun Apr 28 2024 19:27:34 GMT+0800 (中国标准时间) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1305+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 29 2024 03:52:56 GMT+0800 (中国标准时间) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
13061306
</footer>
13071307

13081308
<script>prettyPrint();</script>

docs/exception/1.0.0/index.html renamed to docs/exception/0.0.0/index.html

+3-2
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Exception
4444

4545

4646
<section class="package">
47-
<h3>exception 1.0.0</h3>
47+
<h3>exception 0.0.0</h3>
4848
</section>
4949

5050

@@ -67,6 +67,7 @@ <h3>exception 1.0.0</h3>
6767
<hr>
6868
<p><img src="https://img.shields.io/badge/NodeJS-%E2%89%A514.x-lightseagreen?logo=powershell" alt="nodejs">
6969
<img src="https://img.shields.io/badge/Version-1.0.0-cornflowerblue" alt="Version">
70+
<a href="https://codecov.io/gh/kabeep/exception"><img src="https://codecov.io/gh/kabeep/exception/graph/badge.svg?token=KZH2CVD2CD" alt="codecov"></a>
7071
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-slateblue" alt="License"></a></p>
7172
<p>English | <a href="README.zh-CN.md">简体中文</a></p>
7273
</div>
@@ -190,7 +191,7 @@ <h2>📄 License</h2>
190191
<br class="clear">
191192

192193
<footer>
193-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Sun Apr 28 2024 21:49:54 GMT+0800 (中国标准时间) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
194+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 29 2024 03:52:56 GMT+0800 (中国标准时间) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
194195
</footer>
195196

196197
<script>prettyPrint();</script>

docs/exception/1.0.0/index.js.html renamed to docs/exception/0.0.0/index.js.html

+20-14
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,16 @@ <h1 class="page-title">index.js</h1>
4545

4646
<section>
4747
<article>
48-
<pre class="prettyprint source linenums"><code>import chalk from 'chalk';
49-
import { basename, dirname } from 'path';
50-
import process from 'process';
48+
<pre class="prettyprint source linenums"><code>'use strict';
49+
50+
var chalk = require('chalk');
51+
var path = require('path');
52+
var process = require('process');
53+
54+
function _interopDefault (e) { return e &amp;&amp; e.__esModule ? e : { default: e }; }
55+
56+
var chalk__default = /*#__PURE__*/_interopDefault(chalk);
57+
var process__default = /*#__PURE__*/_interopDefault(process);
5158

5259
// src/core/PaletteError.ts
5360

@@ -137,19 +144,18 @@ <h1 class="page-title">index.js</h1>
137144
* @returns {Chalk} A Chalk instance with the specified styles.
138145
*/
139146
palette(styles = [], chain) {
140-
console.log("styles: ", styles);
141147
const isArray = Array.isArray(styles);
142148
const isIllegal = !isArray &amp;&amp; !is_string_default(styles);
143149
if (isIllegal)
144-
return chalk;
150+
return chalk__default.default;
145151
if (is_string_default(styles)) {
146152
styles = [styles];
147153
}
148154
const style = styles.pop();
149155
const isLatest = styles.length === 0;
150-
let nextChain = this.factory(chain != null ? chain : chalk, style);
156+
let nextChain = this.factory(chain != null ? chain : chalk__default.default, style);
151157
if (!nextChain) {
152-
nextChain = chain != null ? chain : chalk;
158+
nextChain = chain != null ? chain : chalk__default.default;
153159
console.log(`ReferenceWarn: Unexpected ${style} style for chalk chain`);
154160
}
155161
if (isLatest) {
@@ -254,8 +260,8 @@ <h1 class="page-title">index.js</h1>
254260
filepath = remaining;
255261
}
256262
if (filepath) {
257-
file = basename(filepath);
258-
directory = dirname(filepath);
263+
file = path.basename(filepath);
264+
directory = path.dirname(filepath);
259265
if (directory === ".")
260266
directory = "";
261267
file = normalize_path_default(file);
@@ -313,15 +319,15 @@ <h1 class="page-title">index.js</h1>
313319
* @returns {string} The formatted trace information.
314320
*/
315321
print(track) {
316-
const root = process.cwd();
322+
const root = process__default.default.cwd();
317323
const { length } = track;
318324
return track.map((item, index) => {
319325
var _a, _b;
320326
if (!item)
321327
return;
322328
const title = this.palette("yellowBright")(`${item.file}:${item.line}`);
323329
const summary = `- ${title} ${item.name}`;
324-
const current = item.packageName.replace("[current]", basename(root));
330+
const current = item.packageName.replace("[current]", path.basename(root));
325331
const startIndex = (_a = item.address) == null ? void 0 : _a.indexOf(current);
326332
if (typeof startIndex !== "number" || startIndex === -1)
327333
return;
@@ -359,7 +365,7 @@ <h1 class="page-title">index.js</h1>
359365
*/
360366
calc(length, defaultLength = 32) {
361367
var _a;
362-
const clientWidth = (((_a = process.stdout) == null ? void 0 : _a.columns) || defaultLength) - length;
368+
const clientWidth = (((_a = process__default.default.stdout) == null ? void 0 : _a.columns) || defaultLength) - length;
363369
return clientWidth &lt;= 0 ? defaultLength : clientWidth;
364370
}
365371
/**
@@ -405,7 +411,7 @@ <h1 class="page-title">index.js</h1>
405411
};
406412
var Exception_default = Exception;
407413

408-
export { Exception_default as default };
414+
module.exports = Exception_default;
409415
</code></pre>
410416
</article>
411417
</section>
@@ -420,7 +426,7 @@ <h1 class="page-title">index.js</h1>
420426
<br class="clear">
421427

422428
<footer>
423-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Sun Apr 28 2024 21:49:54 GMT+0800 (中国标准时间) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
429+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 29 2024 03:52:56 GMT+0800 (中国标准时间) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
424430
</footer>
425431

426432
<script>prettyPrint();</script>

0 commit comments

Comments
 (0)