Skip to content

Commit 8e90af0

Browse files
committed
feat!: change current exported function "log"
BREAKING CHANGE: the exports on this package have changed. The current functionality has moved to a `log` function in the exports.
1 parent 6442a36 commit 8e90af0

File tree

3 files changed

+22
-23
lines changed

3 files changed

+22
-23
lines changed

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ log events that can be consumed by a listener on the process object.
88

99
## API
1010

11+
```js
12+
const { log } = require('proc-log')
13+
```
14+
1115
* `log.error(...args)` calls `process.emit('log', 'error', ...args)`
1216
The highest log level. For printing extremely serious errors that
1317
indicate something went wrong.
@@ -87,4 +91,4 @@ process.on('log', (level, ...args) => {
8791
process.on('log', (...args) => {
8892
fs.appendFileSync('debug.log', args.join(' '))
8993
})
90-
```
94+
```

lib/index.js

+16-21
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,18 @@
1-
// emits 'log' events on the process
2-
const LEVELS = [
3-
'notice',
4-
'error',
5-
'warn',
6-
'info',
7-
'verbose',
8-
'http',
9-
'silly',
10-
'pause',
11-
'resume',
12-
]
13-
14-
const log = level => (...args) => process.emit('log', level, ...args)
15-
16-
const logger = {}
17-
for (const level of LEVELS) {
18-
logger[level] = log(level)
1+
const log = {
2+
LEVELS: [
3+
'notice',
4+
'error',
5+
'warn',
6+
'info',
7+
'verbose',
8+
'http',
9+
'silly',
10+
'pause',
11+
'resume',
12+
],
13+
}
14+
for (const level of log.LEVELS) {
15+
log[level] = (...args) => process.emit('log', level, ...args)
1916
}
2017

21-
logger.LEVELS = LEVELS
22-
23-
module.exports = logger
18+
module.exports = { log }

test/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const t = require('tap')
2-
const log = require('../')
2+
const { log } = require('../')
33
const { LEVELS } = log
44

55
t.matchSnapshot(LEVELS, 'log levels')

0 commit comments

Comments
 (0)