-
+
+
-# 
-
-
-
-
-
-
-
-**Dear diary, you make my logging so easy**
-
-
- 
-
-
- 
-
-
- 
-
-
- 
-
+[](https://npm-stat.com/charts.html?package=diary)
+[](https://licenses.dev/npm/diary)
+[](https://bundlephobia.com/package/diary)
-
@@ -39,143 +20,48 @@ This is free to use software, but if you do like it, consisder supporting me ❤
-## ⚡ Features
-
-- No [dependencies](https://npm.anvaka.com/#/view/2d/diary)
-- Outstanding [performance](#-benchmark)
-- Support for [`debug`'s filter](https://www.npmjs.com/package/debug#wildcards)
-
## ⚙️ Install
-```sh
+> Avaliable on [jsr](https://jsr.io/@mr/log), [NPM](https://npmjs.com/package/diary) and
+> [deno.land](https://deno.land/x/diary)
+
+```shell
npm add diary
```
## 🚀 Usage
```ts
-import { info, diary, enable } from 'diary';
+import { diary } from 'diary';
+import { pretty } from 'diary/output.console';
-// 1️⃣ Choose to enable the emission of logs, or not.
-enable('*');
+let user = { name: 'marais', type: 'admin' };
-// 2️⃣ log something
-info('this important thing happened');
-// ~> ℹ info this important thing happened
-
-// Maybe setup a scoped logger
-const scopedDiary = diary('my-module', (event) => {
- if (event.level === 'error') {
- Sentry.captureException(event.error);
- }
-});
-
-// 3️⃣ log more things
-scopedDiary.info('this other important thing happened');
-// ~> ℹ info [my-module] this other important thing happened
-```
-
-
-
-
-
-
+[](https://npm-stat.com/charts.html?package=diary)
+[](https://licenses.dev/npm/diary)
+[](https://bundlephobia.com/package/diary)
-@@ -39,143 +20,48 @@ This is free to use software, but if you do like it, consisder supporting me ❤
Node users
+// 1️⃣ create a diary +let log = diary(pretty); -The `enable` function is executed for you from the `DEBUG` environment variable. And as a drop in replacement for -`debug`. +// 2️⃣ log something +log('info', '{name} is now {type}', { name: 'marais', type: 'admin' }); +// ~> ℹ info marais is now admin -```shell -DEBUG=client:db,server:* node example.js +// 💡 log message as completely typesafe +log('debug', '{name} was created {at}', { name: 'marais' }); +// ^? Error: 'at' is not defined ```
->
-
-#### name
-
-Type: `string`
-
-The name given to this _diary_—and will also be available in all logEvents.
+:construction: Talk about structured logging
-#### onEmit (optional)
+:construction: Talk about fragments vs sentences
-Type: `Reporter`
+:construction: Talk about onEmit
-A reporter is run on every log message (provided its [enabled](#enablequery-string)). A reporter gets given the
-`LogEvent` interface:
+:construction: Show /using and /stream
-```ts
-interface LogEvent {
- name: string;
- level: LogLevels;
-
- messages: any[];
-}
-```
-
-> _Note_: you can attach any other context in middleware.
->
->