[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8,"_9":10,"_11":12},"actionData","errors","root",{"_163":-5,"_166":167,"_168":169},"routes/shell",{"_41":42,"_162":-5,"_163":-5,"_164":165},"routes/repo",{"_34":-7,"_35":36,"_37":38,"_39":40,"_41":42,"_43":32,"_44":32,"_45":32,"_46":32,"_47":32,"_48":32,"_49":50,"_51":52,"_53":32,"_54":-7,"_55":-7,"_56":57,"_58":59,"_60":61,"_62":-5,"_63":64,"_65":66,"_67":68,"_69":70},"routes/repo.blob",{"_13":14,"_15":16,"_17":18,"_19":20,"_21":22,"_23":24,"_25":-5,"_26":27,"_28":29,"_29":30,"_31":32,"_33":14},"ref","main","path","readme.md","oid","46e27140e9f3f4c99af3d0b057c29a6ac68e8bf9","size",4740,"commit","6d1aa150e96a9bcdc80337c2b221a2548bd9090c","mounts",[],"source","plain",{"_13":14,"_15":16},"kind","text","

\n\n# ![diary](.github/logo.png)\n\n

\n\n

\n\n**Dear diary, you make my logging so easy**\n\n[![npm downloads](https://badgen.net/npm/dw/diary?color=black&label=npm%20downloads)](https://npm-stat.com/charts.html?package=diary)\n[![size](https://badgen.net/bundlephobia/minzip/diary?color=black)](https://bundlephobia.com/package/diary)\n[![licenses](https://licenses.dev/b/npm/diary?style=dark)](https://licenses.dev/npm/diary)\n\n
\n
\n\n^{\n\nThis is free to use software, but if you do like it, consider supporting me ❤️\n\n[![sponsor me](https://badgen.net/badge/icon/sponsor?icon=github&label&color=gray)](https://github.com/sponsors/maraisr)\n[![buy me a coffee](https://badgen.net/badge/icon/buymeacoffee?icon=buymeacoffee&label&color=gray)](https://www.buymeacoffee.com/marais)\n\n}\n\n

\n\n## ⚡ Features\n\n- No [dependencies](https://npm.anvaka.com/#/view/2d/diary)\n- Outstanding [performance](#-benchmark)\n- Support for [`debug`'s filter](https://www.npmjs.com/package/debug#wildcards)\n\n## ⚙️ Install\n\n```sh\nnpm add diary\n```\n\n## 🚀 Usage\n\n```ts\nimport { info, diary, enable } from 'diary';\n\n// 1️⃣ Choose to enable the emission of logs, or not.\nenable('*');\n\n// 2️⃣ log something\ninfo('this important thing happened');\n// ~> ℹ info this important thing happened\n\n// Maybe setup a scoped logger\nconst scopedDiary = diary('my-module', (event) => {\n if (event.level === 'error') {\n Sentry.captureException(event.error);\n }\n});\n\n// 3️⃣ log more things\nscopedDiary.info('this other important thing happened');\n// ~> ℹ info [my-module] this other important thing happened\n```\n\n

Node users

\n\nThe `enable` function is executed for you from the `DEBUG` environment variable. And as a drop-in replacement for\n`debug`.\n\n```shell\nDEBUG=client:db,server:* node example.js\n```\n\n

\n\n## 🔎 API\n\n### diary(name: string, onEmit?: Reporter)\n\nReturns: [log functions](#log-functions)\n\n> A default diary is exported, accessible through simply importing any [log function](#log-functions).\n>\n>

\n>

Example of default diary

\n>\n> ```ts\n> import { info } from 'diary';\n>\n> info(\"i'll be logged under the default diary\");\n> ```\n>\n>

\n\n#### name\n\nType: `string`\n\nThe name given to this _diary_—and will also be available in all logEvents.\n\n#### onEmit (optional)\n\nType: `Reporter`\n\nA reporter is run on every log message (provided it's [enabled](#enablequery-string)). A reporter gets given the\n`LogEvent` interface:\n\n```ts\ninterface LogEvent {\n name: string;\n level: LogLevels;\n\n messages: any[];\n}\n```\n\n> _Note_: you can attach any other context in middleware.\n>\n>

Example

\n>\n> ```ts\n> import { diary, default_reporter } from 'diary';\n> const scope = diary('scope', (event) => {\n> event.ts = new Date();\n> return default_reporter(event);\n> });\n> ```\n>\n>

\n\nFor errors (`error` and `fatal`) there is also an `error: Error` property.\n\n### _log functions_\n\nA set of functions that map to `console.error`, `console.warn`, `console.debug`, `console.info` and `console.info`.\nAptly named:\n\n`fatal`, `error`, `warn`, `debug`, `info`, and `log`. All of which follow the same API signature:\n\n```ts\ndeclare logFunction(message: object | Error | string, ...args: unknown[]): void;\n```\n\nAll parameters are simply spread onto the function and reported. Node/browser's built-in formatters will format any\nobjects (by default).\n\n```ts\ninfo('hi there'); // ℹ info hi there\ninfo('hi %s', 'there'); // ℹ info hi there\ninfo('hi %j', { foo: 'bar' }); // ℹ info hi { \"foo\": \"bar\" }\ninfo('hi %o', { foo: 'bar' }); // ℹ info hi { foo: 'bar' }\ninfo({ foo: 'bar' }); // ℹ info { foo: 'bar' }\n```\n\n#### diary (optional)\n\nType: `Diary`\n\nThe result of calling [diary](#diary-name-string);\n\n### enable(query: string)\n\nType: `Function`\n\nOpts certain log messages into being output. See more [here](#programmatic).\n\n## 💨 Benchmark\n\n> via the [`/bench`](/bench) directory with Node v20.2.0\n\n```\nJIT\n✔ diary ~ 1,434,414 ops/sec ± 0.16%\n✔ pino ~ 47,264 ops/sec ± 0.02%\n✔ bunyan ~ 9,644 ops/sec ± 0.01%\n✔ debug ~ 444,612 ops/sec ± 0.22%\n\nAOT\n✔ diary ~ 1,542,796 ops/sec ± 0.29%\n✔ pino ~ 281,232 ops/sec ± 0.03%\n✔ bunyan ~ 588,768 ops/sec ± 0.16%\n✔ debug ~ 1,287,846 ops/sec ± 0.24%\n```\n\n> AOT: The logger is set up ahead of time, and ops/sec is the result of calling the log fn. Simulates long-running\n> process, with a single logger. JIT: The logger is set up right before the log fn is called per op. Simulates setting\n> up a logger per request for example.\n\n## License\n\nMIT © [Marais Rossouw](https://marais.io)\n","editable",false,"branch","documentNavigation","repo","maraisr/diary","repoId","223e13eb-e588-46f3-9ac1-cbf4ecca1bdc","ownerId","user:599459","site","nexthub","private","admin","settings","maintainer","triage","starred","stars",0,"watchers",1,"watching","pinned","notify","views",[118,119,120,121,122,123,124,125,126,127,128,129,130],"navigation",{"_56":57,"_78":79,"_80":81,"_82":83,"_84":85,"_86":87,"_88":89},"sources",[],"viewer","meta",{"_71":72,"_73":74,"_75":72,"_43":32,"_76":14,"_77":32,"_49":50,"_51":52},"branches",[14],"tags",[],"cloneUrl","https://git.nexthub.sh/maraisr/diary.git","description","","owner","maraisr","section","head","empty","pins",[100,101,102],"documents",{"_97":98,"_99":50},"code",{"_94":95,"_96":50},"automations",{"_92":52,"_93":-5},"delivery",{"_90":50,"_91":-5},"tag","1ZznoccJPtl_v-dMmYG_KIsmuk7","releases","applications","workflows","deployments","commits",139,"changes","counts",{},"total",{"_103":96,"_105":116,"_15":96,"_107":117,"_54":109,"_110":32,"_111":109,"_112":50},{"_103":113,"_105":114,"_15":113,"_107":115,"_54":109,"_110":32,"_111":109,"_112":50},{"_103":104,"_105":106,"_15":104,"_107":108,"_54":109,"_110":32,"_111":109,"_112":50},"id","issues","name","Issues","filters",{},true,"saved","pinnable","count","tasks","Tasks",{},"Changes",{},{"_103":96,"_105":116,"_15":96,"_107":161,"_54":109,"_110":32,"_111":109},{"_103":113,"_105":114,"_15":113,"_107":160,"_54":109,"_110":32,"_111":109},{"_103":104,"_105":106,"_15":104,"_107":159,"_54":109,"_110":32,"_111":109},{"_103":156,"_105":157,"_15":156,"_107":158,"_54":32,"_110":32,"_111":109},{"_103":153,"_105":154,"_15":153,"_107":155,"_54":32,"_110":32,"_111":109},{"_103":92,"_105":151,"_15":84,"_107":152,"_54":32,"_110":32,"_111":109},{"_103":93,"_105":148,"_15":149,"_107":150,"_54":32,"_110":32,"_111":109},{"_103":90,"_105":146,"_15":90,"_107":147,"_54":32,"_110":32,"_111":109},{"_103":142,"_105":143,"_15":144,"_107":145,"_54":32,"_110":32,"_111":109},{"_103":80,"_105":140,"_15":80,"_107":141,"_54":32,"_110":32,"_111":32},{"_103":137,"_105":138,"_15":137,"_107":139,"_54":32,"_110":32,"_111":32},{"_103":134,"_105":135,"_15":134,"_107":136,"_54":32,"_110":32,"_111":32},{"_103":131,"_105":132,"_15":131,"_107":133,"_54":32,"_110":32,"_111":32},"decisions","Decisions",{},"changelog","Changelog",{},"roadmap","Roadmap",{},"Documents",{},"activity","Activity","insights",{},"Releases",{},"Deployments","automations/deployments",{},"Workflows",{},"discussions","Discussions",{},"goals","Goals",{},{},{},{},"groups","user","agents",[],"now",1794433517581,"sidebar","expanded"]