https://github.com/nahco3-code/arenats-rich
https://github.com/nahco3-code/arenats-rich
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nahco3-code/arenats-rich
- Owner: NaHCO3-code
- License: mit
- Created: 2024-08-03T16:35:41.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-11T14:38:19.000Z (over 1 year ago)
- Last Synced: 2025-04-10T05:41:50.075Z (about 1 year ago)
- Language: TypeScript
- Size: 281 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Arena-Rich
得到更好的控制台输出
# Features
- 清晰的层级显示，让输出更美观
- 自动展开对象、数组
- 自定义最大对象深度、字符串最大长度、占位符、省略字符等
- 循环引用检测
- Logger 自定义输出目标，日志管理更清晰
# Usage
引入 Rich 对象
```ts
import { Rich } from '@dao3fun/arena-rich'
```
使用`Rich.print()`输出各种内容
```ts
Rich.print("hello world");
Rich.print(993244853);
Rich.print({
name: "surfish",
age: null,
gender: undefined,
friends: [
"Alray",
"laiq"
],
address: {
country: "China"
}
});
Rich.print(new Date());
Rich.print(1145141919810n);
Rich.print(Symbol("arena"));
Rich.print(world);
```
输出结果：
使用 Logger
```ts
import { Logger } from '@dao3fun/arena-rich'
const Game = new Logger(console.log, "GAME");
const DatabaseWarn = new Logger(console.warn, "DB");
Game.log("Game started");
DatabaseWarn.log("Max read/write limitation exceed");
```
# Configs
## Rich.enable: bool
选择是否启用 Rich 输出，默认为 true。
## Rich.config
配置 Rich 输出的参数
### config.maxDepth: number
输出对象的最大深度，默认为 5。
### config.maxStringLength: number
输出字符串的最大长度，默认为 80。如果字符串超过这个长度，将会从中间位置截断，并添加省略号。
### config.placeholder: string
如果对象嵌套深度超过了 `config.maxDepth`，将会显示这个占位符。默认为 `(...)`。
### config.tab: string
由于 Arena 编辑器中控制台会忽略所有空格，需要有一些字符代替空格展示缩进关系。默认为 `---|`。
# Classes
# Rich
## Rich.print(...args: any[]): void
在控制台输出内容
## Rich.objToString(obj: any, depth: number = 0): string
arena-rich 内部使用的方法，将任意对象转换为字符串
# Logger
## constructor(logFn: (msg: string) => void, tag: string)
### Params
| 参数 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| logFn | (msg: string) => void | console.log | 用于输出的函数 |
| tag | string | "" | 标签 |
## log(...args: any[])
输出日志