# 
**Dear diary, you make my logging so easy**
[](https://npm-stat.com/charts.html?package=diary)
[](https://bundlephobia.com/package/diary)
[](https://licenses.dev/npm/diary)
This is free to use software, but if you do like it, consider supporting me ❤️
[](https://github.com/sponsors/maraisr)
[](https://www.buymeacoffee.com/marais)
## ⚡ 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
npm add diary
```
## 🚀 Usage
```ts
import { info, diary, enable } from 'diary';
// 1️⃣ Choose to enable the emission of logs, or not.
enable('*');
// 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
```
Node users
The `enable` function is executed for you from the `DEBUG` environment variable. And as a drop-in replacement for
`debug`.
```shell
DEBUG=client:db,server:* node example.js
```
> Example of default diary
>
> ```ts
> import { info } from 'diary';
>
> info("i'll be logged under the default diary");
> ```
>
>
#### name
Type: `string`
The name given to this _diary_—and will also be available in all logEvents.
#### onEmit (optional)
Type: `Reporter`
A reporter is run on every log message (provided it's [enabled](#enablequery-string)). A reporter gets given the
`LogEvent` interface:
```ts
interface LogEvent {
name: string;
level: LogLevels;
messages: any[];
}
```
> _Note_: you can attach any other context in middleware.
>
> Example
>
> ```ts
> import { diary, default_reporter } from 'diary';
> const scope = diary('scope', (event) => {
> event.ts = new Date();
> return default_reporter(event);
> });
> ```
>
>