# diary-cli > Diary's cli Latest version **0.0.1** (published 2020-12-24) · MIT license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install diary-cli pnpm add diary-cli yarn add diary-cli bun add diary-cli ``` ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 0.0.1 | | Published | 2020-12-24 | | First published | 2020-12-24 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 352 B | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 264 | | Author | Marais Rossouw | | Maintainers | marais | | Keywords | fast, logging, logger, utility | ## Links - npm: https://www.npmjs.com/package/diary-cli - 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-cli ## 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 - [@luma.gl/experimental](https://npm.io/package/@luma.gl/experimental.md) — 77.1K 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 ## Recent versions - 0.0.1 (latest) — 2020-12-24 ## README
# ![diary](.github/logo.png)
**Dear diary, you make my logging so easy** [![npm downloads](https://badgen.net/npm/dw/diary?color=black&label=npm%20downloads)](https://npm-stat.com/charts.html?package=diary) [![size](https://badgen.net/bundlephobia/minzip/diary?color=black)](https://bundlephobia.com/package/diary) [![licenses](https://licenses.dev/b/npm/diary?style=dark)](https://licenses.dev/npm/diary)

This is free to use software, but if you do like it, consider supporting me ❤️ [![sponsor me](https://badgen.net/badge/icon/sponsor?icon=github&label&color=gray)](https://github.com/sponsors/maraisr) [![buy me a coffee](https://badgen.net/badge/icon/buymeacoffee?icon=buymeacoffee&label&color=gray)](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 ```
## 🔎 API ### diary(name: string, onEmit?: Reporter) Returns: [log functions](#log-functions) > A default diary is exported, accessible through simply importing any [log function](#log-functions). > >
> 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); > }); > ``` > >
For errors (`error` and `fatal`) there is also an `error: Error` property. ### _log functions_ A set of functions that map to `console.error`, `console.warn`, `console.debug`, `console.info` and `console.info`. Aptly named: `fatal`, `error`, `warn`, `debug`, `info`, and `log`. All of which follow the same API signature: ```ts declare logFunction(message: object | Error | string, ...args: unknown[]): void; ``` All parameters are simply spread onto the function and reported. Node/browser's built-in formatters will format any objects (by default). ```ts info('hi there'); // ℹ info hi there info('hi %s', 'there'); // ℹ info hi there info('hi %j', { foo: 'bar' }); // ℹ info hi { "foo": "bar" } info('hi %o', { foo: 'bar' }); // ℹ info hi { foo: 'bar' } info({ foo: 'bar' }); // ℹ info { foo: 'bar' } ``` #### diary (optional) Type: `Diary` The result of calling [diary](#diary-name-string); ### enable(query: string) Type: `Function` Opts certain log messages into being output. See more [here](#programmatic). ## 💨 Benchmark > via the [`/bench`](/bench) directory with Node v20.2.0 ``` JIT ✔ diary ~ 1,434,414 ops/sec ± 0.16% ✔ pino ~ 47,264 ops/sec ± 0.02% ✔ bunyan ~ 9,644 ops/sec ± 0.01% ✔ debug ~ 444,612 ops/sec ± 0.22% AOT ✔ diary ~ 1,542,796 ops/sec ± 0.29% ✔ pino ~ 281,232 ops/sec ± 0.03% ✔ bunyan ~ 588,768 ops/sec ± 0.16% ✔ debug ~ 1,287,846 ops/sec ± 0.24% ``` > AOT: The logger is set up ahead of time, and ops/sec is the result of calling the log fn. Simulates long-running > process, with a single logger. JIT: The logger is set up right before the log fn is called per op. Simulates setting > up a logger per request for example. ## License MIT © [Marais Rossouw](https://marais.io) --- _Source: https://npm.io/package/diary-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._