# diary
> Fast effective logging library for both Node, the Browser, and Workers!
Latest version **0.4.5** (published 2024-01-19) · MIT license · 0 weekly downloads
## Install
```sh
npm install diary
pnpm add diary
yarn add diary
bun add diary
```
## Health
**Score 30/100 (F)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities; high quality score.
Warnings: low downloads; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.4.5 |
| Published | 2024-01-19 |
| First published | 2013-03-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 16.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 265 |
| Author | Marais Rossow |
| Maintainers | marais |
| Keywords | fast, logging, utility, middleware, debug, logger |
## Links
- npm: https://www.npmjs.com/package/diary
- Repository: https://github.com/maraisr/diary
- Homepage: https://github.com/maraisr/diary#readme
- Issues: https://github.com/maraisr/diary/issues
- npm.io page: https://npm.io/package/diary
## Alternatives
- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads
## Recent versions
- 0.4.5 (latest) — 2024-01-19
- 0.5.0-next.2 (next) — 2024-09-06
- 0.5.0-alpha.2 (alpha) — 2024-06-01
- 0.5.0-next.1 — 2024-09-06
- 0.5.0-alpha.1 — 2024-05-27
- 0.4.4 — 2023-03-16
- 0.4.3 — 2022-10-25
- 0.4.2 — 2022-10-20
- 0.4.1 — 2022-10-10
- 0.4.0 — 2022-10-10
- 0.3.1 — 2022-06-18
- 0.3.0 — 2021-11-04
- 0.2.2 — 2021-09-14
- 0.2.1 — 2021-09-14
- 0.2.0 — 2021-08-27
- … 19 more at https://npm.io/package/diary/versions
## README
# 
## ⚡ 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 its [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);
> });
> ```
>
> 
