Skip to content

Commit 807ccb1

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

File tree

2 files changed

+36
-29
lines changed

2 files changed

+36
-29
lines changed

README.md

Lines changed: 16 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,23 @@
1-
# Devtools Shared Monorepo
1+
# mongodb-log-writer
22

3-
This repository contains packages that are shared dependencies of Compass, the MongoDB extension for VSCode and MongoSH.
3+
A library for writing MongoDB logv2 messages.
44

5-
To start working:
5+
```js
6+
import { MongoLogManager, mongoLogId } from 'mongodb-log-writer';
67

7-
```
8-
npm run bootstrap
9-
```
10-
11-
Lint code and dependencies
12-
13-
```
14-
npm run check
15-
```
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();
1616

17-
Run tests
18-
19-
```
20-
npm run test
21-
```
22-
23-
To create a new workspace:
24-
25-
```
26-
npm run create-workspace
17+
const writer = manager.createLogWriter();
18+
writer.info('component', mongoLogId(12345), 'context', 'message', { foo: 'bar' });
2719
```
2820

29-
## Contributing
21+
## LICENSE
3022

31-
For contributing, please refer to [CONTRIBUTING.md](CONTRIBUTING.md)
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)