Skip to content

Commit e448d34

Browse files
add formatters
1 parent 1ec313a commit e448d34

4 files changed

Lines changed: 37 additions & 16 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,21 @@
11
# debug-factory
22
Factory for creating debug loggers
3+
4+
```TypeScript
5+
import DebugFactory from "debug-factory";
6+
7+
const [log, error] = DebugFactory.getDebuggers("MyApp");
8+
9+
log("This is a log");
10+
error("this is a error");
11+
```
12+
13+
With a custom formatter
14+
15+
```TypeScript
16+
const [log, error] = DebugFactory.getDebuggers("Memory", {
17+
x: (v) => v.toString(16)
18+
});
19+
20+
log("putByte: add:0x%x val:0x%x", address, byte);
21+
```

package-lock.json

Lines changed: 10 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "debug-factory",
3-
"version": "1.0.2",
3+
"version": "1.0.3",
44
"description": "Factory for creating debug loggers",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",
@@ -32,9 +32,9 @@
3232
"devDependencies": {
3333
"@jest/globals": "^29.7.0",
3434
"@types/debug": "^4.1.12",
35-
"@types/jest": "^29.5.10",
35+
"@types/jest": "^29.5.11",
3636
"jest": "^29.7.0",
3737
"ts-jest": "^29.1.1",
38-
"typescript": "^5.3.2"
38+
"typescript": "^5.3.3"
3939
}
4040
}

src/DebugFactory.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
import debug from "debug";
1+
import debug, { Formatters } from "debug";
22

33
export type Debugger = debug.Debugger;
44

55
class DebugFactory {
6-
static getDebugger(name: string): Debugger {
6+
static getDebugger(name: string, formatters?: Formatters): Debugger {
7+
debug.formatters = { ...debug.formatters, ...formatters };
78
return debug(name);
89
}
910

10-
static getDebuggers(name: string): Debugger[] {
11+
static getDebuggers(name: string, formatters?: Formatters): Debugger[] {
12+
debug.formatters = { ...debug.formatters, ...formatters };
1113
return [debug(name), debug(`${name}:error`)];
1214
}
1315
}

0 commit comments

Comments
 (0)