Skip to content

Commit 703b7b1

Browse files
README: make more clear that data is nested under 'data' field
1 parent 9d91104 commit 703b7b1

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,27 @@ logger.warn('Request rate limited', { ip: '127.0.0.1' })
3434
logger.error('🚨 Unexpected Error', new Error('Failed to connect to Postgress'))
3535
```
3636

37+
Will log these fields at the top level:
38+
39+
- `time`: a RFC3339 timestamp
40+
- `level`: the log level
41+
- `message`: the log message
42+
- `data`: an object containing any additional fields that have been logged.
43+
44+
For example:
45+
46+
```javascript
47+
logger.info("test", {some: 'data'})
48+
{
49+
"level":"INFO",
50+
"time":"2019-01-01T00:00:00.000Z",
51+
"message":"test",
52+
"data": {
53+
"some":"data"
54+
}
55+
}
56+
```
57+
3758
## API
3859

3960
### new Logger(options?)

src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ export class Logger {
124124
level: level.toUpperCase(),
125125
time: new Date().toISOString(),
126126
message,
127-
data,
127+
data: data,
128128
}
129129

130130
// Create JSON string with all the exotic values converted to JSON safe versions

0 commit comments

Comments
 (0)