{"id":16270929,"url":"https://github.com/ivanmarban/winston-telegram","last_synced_at":"2025-05-08T21:44:25.934Z","repository":{"id":2246079,"uuid":"46059824","full_name":"ivanmarban/winston-telegram","owner":"ivanmarban","description":"A Telegram transport for winston","archived":false,"fork":false,"pushed_at":"2024-06-16T10:17:43.000Z","size":996,"stargazers_count":45,"open_issues_count":1,"forks_count":21,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-02T02:02:17.774Z","etag":null,"topics":["logger","logging-library","node","node-js","telegram","telegram-bot","winston-transport","winston3","winstonjs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/ivanmarban.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":"2015-11-12T14:54:53.000Z","updated_at":"2025-03-15T20:58:09.000Z","dependencies_parsed_at":"2024-06-18T21:12:40.430Z","dependency_job_id":"39161bd8-2ac5-44c5-a9cd-3603f3a8b0b2","html_url":"https://github.com/ivanmarban/winston-telegram","commit_stats":{"total_commits":141,"total_committers":13,"mean_commits":"10.846153846153847","dds":"0.12765957446808507","last_synced_commit":"3c25b8f9fa5bdf115eac2bea6331bd9b9f9a3c21"},"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivanmarban%2Fwinston-telegram","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivanmarban%2Fwinston-telegram/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivanmarban%2Fwinston-telegram/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivanmarban%2Fwinston-telegram/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ivanmarban","download_url":"https://codeload.github.com/ivanmarban/winston-telegram/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253154129,"owners_count":21862461,"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-library","node","node-js","telegram","telegram-bot","winston-transport","winston3","winstonjs"],"created_at":"2024-10-10T18:12:00.291Z","updated_at":"2025-05-08T21:44:25.895Z","avatar_url":"https://github.com/ivanmarban.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# winston-telegram\n\n[![NPM](https://nodei.co/npm/winston-telegram.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/winston-telegram/)\n\nA [Telegram][0] transport for [winston][1].\n\n[![Version npm](https://img.shields.io/npm/v/winston-telegram.svg)](https://www.npmjs.com/package/winston-telegram)\n[![npm Downloads](https://img.shields.io/npm/dw/winston-telegram.svg)](https://npmcharts.com/compare/winston-telegram?minimal=true)\n[![CI Status](https://github.com/ivanmarban/winston-telegram/actions/workflows/ci.yaml/badge.svg?branch=master)](https://github.com/ivanmarban/winston-telegram/actions/workflows/ci.yaml)\n[![Coverage Status](https://coveralls.io/repos/github/ivanmarban/winston-telegram/badge.svg?branch=master)](https://coveralls.io/github/ivanmarban/winston-telegram?branch=master)\n[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n\n## winston-telegram@2\n\nInstallation:\n``` sh\n$ npm install winston@3\n$ npm install winston-telegram@2\n```\n\n## Looking for `winston-telegram@1.x` ?\nDocumentation below is for `winston-telegram@2`. [Read the `winston-telegram@1.x` documentation][2].\n\n## Usage\n``` js\nconst logger = require('winston')\nconst TelegramLogger = require('winston-telegram')\n\n// or\nimport TelegramLogger from 'winston-telegram';\n\nlogger.add(new TelegramLogger(options))\n```\n\nOptions:\n\n* `token` The Telegram bot authentication token. *[required]*\n* `chatId` The Telegram chatid you want to send to. *[required]*\n* `messageThreadId` The Telegram unique identifier of a message thread to which the message belongs. *[optional]*\n* `parseMode` The Telegram mode for parsing entities in the message text. See [formatting options][4] for more details. *[optional]*\n* `level` Level of messages that this transport should log. *[optional]* *[default info]*\n* `unique` Whether to log only the declared level and none above. *[boolean]* *[optional]*\n* `silent` Whether to suppress output. *[boolean]* *[optional]*\n* `disableNotification` Sends the message silently. *[boolean]* *[optional]*\n* `template` Format output message. *[string]* *[optional]*\n* `formatMessage` Format output message by own method. *[function]* *[optional]*\n* `handleExceptions` Handle uncaught exceptions. *[boolean]* *[optional]*\n* `batchingDelay` Time in ms within which to batch messages together. *[integer]* *[optional]* *[default 0 or disabled]*\n* `batchingSeparator` String with which to join batched messages with *[string]* *[default \"\\n\\n\"]*\n\nString template is based on named arguments:\n``` js\n'{level}' -\u003e level of messages\n'{message}' -\u003e text of messages\n'{metadata}' -\u003e metadata object of messages\n```\n\n## Examples\n\nFollow below steps to run the examples:\n\n``` sh\n$ git clone git@github.com:ivanmarban/winston-telegram.git -b master --single-branch\n$ npm install\n```\n\nReplace `TELEGRAM_TOKEN` and `CHAT_ID` with appropiate values, then run whatever example you want:\n\n``` sh\n$ node examples/default-logger.js\n```\n\n[0]: https://telegram.org/\n[1]: https://github.com/flatiron/winston\n[2]: https://github.com/ivanmarban/winston-telegram/tree/1.x\n[3]: https://github.com/ivanmarban/winston-telegram/tree/master/examples\n[4]: https://core.telegram.org/bots/api#formatting-options\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fivanmarban%2Fwinston-telegram","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fivanmarban%2Fwinston-telegram","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fivanmarban%2Fwinston-telegram/lists"}