{"id":18962948,"url":"https://github.com/nrchkb/logger","last_synced_at":"2026-02-10T09:35:29.990Z","repository":{"id":57132192,"uuid":"332088523","full_name":"NRCHKB/logger","owner":"NRCHKB","description":"Unified Logger for Node-RED nodes (using debug)","archived":false,"fork":false,"pushed_at":"2024-07-04T21:50:48.000Z","size":713,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-10T21:26:05.690Z","etag":null,"topics":["logger","logging","typescript"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NRCHKB.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-22T23:43:29.000Z","updated_at":"2024-07-04T21:50:51.000Z","dependencies_parsed_at":"2024-06-20T19:05:04.843Z","dependency_job_id":"05078995-dc56-4cfe-bf2f-0a1de58e4223","html_url":"https://github.com/NRCHKB/logger","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NRCHKB%2Flogger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NRCHKB%2Flogger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NRCHKB%2Flogger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NRCHKB%2Flogger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NRCHKB","download_url":"https://codeload.github.com/NRCHKB/logger/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240788775,"owners_count":19857699,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["logger","logging","typescript"],"created_at":"2024-11-08T14:17:24.750Z","updated_at":"2026-02-10T09:35:29.903Z","avatar_url":"https://github.com/NRCHKB.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @nrchkb/logger\n\nUnified Logger for Node-RED nodes (using debug)\n\n![@nrchkb/logger](https://user-images.githubusercontent.com/2881159/106205731-3f163580-61bf-11eb-8c76-f0ffe9e88a53.png)\n\n## Install\n\n``npm i -d @nrchkb/logger``\n\n## How to use\n\nThere are 3 types of messages:\n\n- Debug - for standard debug purpose.\n- Error - for printing errors, this level is enabled by default.\n- Trace - for printing detailed messaged.\n\nCode\n\n```typescript\nimport {logger} from \"@nrchkb/logger\";\n\nconst log = logger('YOUR_NODE_SHORT_NAME')\n\nlog.debug('Debug message')\nlog.error('Error message')\nlog.trace('Trace message')\n```\n\nStart you app in with DEBUG env\n\n```bash\nDEBUG=YOUR_BASE_NAMESPACE* yourApp.js\n```\n\nIf you want you can pass addional parameters to logger method to make its log message more detailed\n\n```typescript\n// Having Node-RED node in context, node name is TestHTTPNode, id is 1234567890\nlet log\nlog = logger('BASE_NAMESPACE', 'OUT', 'HTTP')\n//or\nlog = logger('BASE_NAMESPACE', 'OUT', this.name, this)\n```\n\n- First argument is namespace prefix used in log message `BASE_NAMESPACE:OUT Some Message`\n- Second argument is suffix namespace used in log message `BASE_NAMESPACE:OUT Some Message`\n- Third is a message prefix `BASE_NAMESPACE:OUT [HTTP] Some Message`\n- Forth, if provided will override message prefix with node name and\n  id  `BASE_NAMESPACE:OUT [TestHTTPNode:1234567890] Some Message`\n\n## Customization\n\nParameters\n\n```typescript\nlet LOGGER_DEBUG_COLOR = process.env.LOGGER_DEBUG_COLOR || '4'\nlet LOGGER_ERROR_COLOR = process.env.LOGGER_ERROR_COLOR || '9'\nlet LOGGER_TRACE_COLOR = process.env.LOGGER_TRACE_COLOR || '15'\n\nlet LOGGER_DEBUG_ENABLED =\n        process.env.LOGGER_DEBUG_ENABLED \u0026\u0026\n        process.env.LOGGER_DEBUG_ENABLED === 'true'\nlet LOGGER_ERROR_ENABLED =\n        (process.env.LOGGER_ERROR_ENABLED \u0026\u0026\n                process.env.LOGGER_ERROR_ENABLED === 'true') ||\n        true\nlet LOGGER_TRACE_ENABLED =\n        process.env.LOGGER_TRACE_ENABLED \u0026\u0026\n        process.env.LOGGER_TRACE_ENABLED === 'true'\n\nlet LOGGER_TIMESTAMP_ENABLED = process.env.LOGGER_TIMESTAMP_ENABLED || false\n```\n\nColors are defined via numbers. Depending on which device you are running your app different range of colors will be\navailable. Please refer to https://jonasjacek.github.io/colors/ for Xterm color list\n\nAll params listed above can be either changed with env variable or setup method\n\n### env parameter\n\nFor example to change debug logs color to pin\n\n```bash\nLOGGER_DEBUG_COLOR=13 DEBUG=MYAPP* yourApp.js\n```\n\n### setup method\n\nAll params are optional, so you can choose which you want to change\n\n```typescript\nimport {loggerSetup} from \"@nrchkb/logger\";\n\nloggerSetup({\n    debugColor: '9',\n    debugEnabled: false,\n    errorColor: '10',\n    errorEnabled: false,\n    traceColor: '11',\n    traceEnabled: false\n})\n```\n\n## Do you need help with your setup?\n\nJoin us on our Discord server (click on the logo below)!\n\n[![NRCHKB Discord](https://discordapp.com/api/guilds/586065987267330068/widget.png?style=banner2)](https://discord.gg/uvYac5u)\n\n## Contact us\n\n- [Our Discord server](https://discord.gg/uvYac5u) [![NRCHKB Discord](https://img.shields.io/discord/586065987267330068.svg?label=Discord)](https://discord.gg/amwV5tq)\n- [Mail directly to Shaquu](mailto:tadeusz@hey.com?subject=[@nrchkb/logger])\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnrchkb%2Flogger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnrchkb%2Flogger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnrchkb%2Flogger/lists"}