Skip to content

Commit b3da7fa

Browse files
committed
fix: update bson verison, align README and add type definitions to package.json
1 parent f7dd1cc commit b3da7fa

File tree

2 files changed

+42
-7
lines changed

2 files changed

+42
-7
lines changed
Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1-
# mongodb-constants
1+
# mongodb-log-writer
22

3-
Shared MongoDB constants for queries, aggregations, bson types, etc
3+
A library for writing MongoDB logv2 messages.
4+
5+
```js
6+
import { MongoLogManager, mongoLogId } from 'mongodb-log-writer';
7+
8+
const manager = new MongoLogManager({
9+
directory: os.homedir() + '/.app-logs',
10+
retentionDays: 30,
11+
onwarn: console.warn,
12+
onerror: console.error,
13+
gzip: true
14+
});
15+
await manager.cleanupOldLogfiles();
16+
17+
const writer = manager.createLogWriter();
18+
writer.info('component', mongoLogId(12345), 'context', 'message', { foo: 'bar' });
19+
```
20+
21+
## LICENSE
22+
23+
Apache-2.0

packages/mongodb-log-writer/package.json

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,26 @@
2424
"logv2"
2525
],
2626
"main": "dist/index.js",
27+
"types": "dist/index.d.ts",
2728
"exports": {
2829
".": {
29-
"require": "./dist/index.js",
30-
"import": "./.esm-wrapper.mjs"
30+
"require": {
31+
"default": "./dist/index.js",
32+
"types": "./dist/index.d.ts"
33+
},
34+
"import": {
35+
"default": "./.esm-wrapper.mjs",
36+
"types": "./dist/index.d.ts"
37+
}
3138
},
32-
"./mongo-log-writer": "./dist/mongo-log-writer.js",
33-
"./mongo-log-manager": "./dist/mongo-log-manager.js"
39+
"./mongo-log-writer": {
40+
"default": "./dist/mongo-log-writer.js",
41+
"types": "./dist/mongo-log-writer.d.ts"
42+
},
43+
"./mongo-log-manager": {
44+
"default": "./dist/mongo-log-manager.js",
45+
"types": "./dist/mongo-log-manager.d.ts"
46+
}
3447
},
3548
"files": [
3649
"LICENSE",
@@ -49,9 +62,11 @@
4962
},
5063
"license": "Apache-2.0",
5164
"dependencies": {
52-
"bson": "^6.8.0",
5365
"heap-js": "^2.3.0"
5466
},
67+
"peerDependencies": {
68+
"bson": "6.x"
69+
},
5570
"devDependencies": {
5671
"@mongodb-js/eslint-config-devtools": "0.9.10",
5772
"@mongodb-js/mocha-config-devtools": "^1.0.4",

0 commit comments

Comments
 (0)