https://github.com/gaubee/console-pro-trace
https://github.com/gaubee/console-pro-trace
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/gaubee/console-pro-trace
- Owner: Gaubee
- Created: 2018-05-06T08:31:16.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-05-18T02:40:45.000Z (about 8 years ago)
- Last Synced: 2025-01-28T18:46:28.925Z (over 1 year ago)
- Language: TypeScript
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# console trace
tarce your function. calc the case time.
when you have cluster process. you can use [mter](https://www.npmjs.com/package/mter) to split the log view.
## usage
```ts
// test/demo1.ts
import { console, registerClassDebug, IS_IN_TRACE_MODE } from '../src/';
class A {
async say(word) {
console.log(word)
}
}
registerClassDebug(A, 'A');
const a = new A();
a.say('qaq');
```
The log is not output by default. You need to configure environment variables:`TRACE` or `CONSOLE_PRO_TRACE`.
for example:
```shell
# in unix
TRACE='*' node your-app.js
# in windows cmd
set TRACE="*"
node your-app.js
# in windows powershell
$env:TRACE="*"
node your-app.js
```
now, run the `demo1.ts`:
`TRACE=* ts-node test/demo1.ts`
> PS:the `console` instance is from [console-pro](https://www.npmjs.com/package/console-pro).
## about the `TRACE`
### example 1
```ts
registerClassDebug(A, 'A');
registerClassDebug(B, 'B');
```
```shell
TRACE="A,B"
```
### example 2
```ts
registerClassDebug(A, 'my/A');
registerClassDebug(B, 'my/B');
```
```shell
TRACE="my/*"
```
## extends config
you can define static function `getUnDebugMethodNames` for class to skip debug some function.
```ts
class A {
async say(word) {
console.log(word)
}
private _dosomething(cb){
setTimeout(cb, 1000)
}
static getUnDebugMethodNames(){
return ["_dosomething"]
}
}
```
## debug an object
```ts
import { console, registerInstanceDebug } from '../src/';
registerInstanceDebug({
async say(word) {
console.log(word)
}
_dosomething(cb){
setTimeout(cb, 1000)
}
getUnDebugMethodNames(){
return ["_dosomething"]
}
}, 'my/simple/instance');
```