Skip to content

Commit

Permalink
chore: update README & CHANGELOG, bump version number
Browse files Browse the repository at this point in the history
  • Loading branch information
ivanmarban committed Jan 6, 2024
1 parent ce51840 commit 3c25b8f
Show file tree
Hide file tree
Showing 4 changed files with 987 additions and 809 deletions.
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

## [Unreleased]

## [v2.7.0] - 2024-01-06
### Added
- [#40](https://github.com/ivanmarban/winston-telegram/issues/40) Support for chats with threads enabled.

## [v2.6.0] - 2022-05-15
### Fixed
- [#36](https://github.com/ivanmarban/winston-telegram/pull/36) Handle uncaught exceptions.
Expand Down Expand Up @@ -173,7 +177,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
## [v0.1.0] - 2015-11-12
- First version.

[unreleased]: https://github.com/ivanmarban/winston-telegram/compare/v2.6.0...develop
[unreleased]: https://github.com/ivanmarban/winston-telegram/compare/v2.7.0...develop
[v2.7.0]: https://github.com/ivanmarban/winston-telegram/compare/v2.6.0...v2.7.0
[v2.6.0]: https://github.com/ivanmarban/winston-telegram/compare/v2.5.0...v2.6.0
[v2.5.0]: https://github.com/ivanmarban/winston-telegram/compare/v2.4.1...v2.5.0
[v2.4.1]: https://github.com/ivanmarban/winston-telegram/compare/v2.4.0...v2.4.1
Expand Down
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,19 @@ logger.add(new TelegramLogger(options))

Options:

* __token:__ The Telegram bot authentication token. *[required]*
* __chatId:__ The Telegram chatid you want to send to. *[required]*
* __parseMode:__ The Telegram mode for parsing entities in the message text. See [formatting options][4] for more details. *[optional]*
* __level:__ Level of messages that this transport should log. *[optional]* *[default info]*
* __unique:__ Whether to log only the declared level and none above. *[boolean]* *[optional]*
* __silent:__ Whether to suppress output. *[boolean]* *[optional]*
* __disableNotification:__ Sends the message silently. *[boolean]* *[optional]*
* __template:__ Format output message. *[string]* *[optional]*
* __formatMessage:__ Format output message by own method. *[function]* *[optional]*
* __handleExceptions:__ Handle uncaught exceptions. *[boolean]* *[optional]*
* __batchingDelay:__ Time in ms within which to batch messages together. *[integer]* *[optional]* *[default 0 or disabled]*
* __batchingSeparator:__ String with which to join batched messages with *[string]* *[default "\n\n"]*
* `token` The Telegram bot authentication token. *[required]*
* `chatId` The Telegram chatid you want to send to. *[required]*
* `messageThreadId` The Telegram unique identifier of a message thread to which the message belongs. *[optional]*
* `parseMode` The Telegram mode for parsing entities in the message text. See [formatting options][4] for more details. *[optional]*
* `level` Level of messages that this transport should log. *[optional]* *[default info]*
* `unique` Whether to log only the declared level and none above. *[boolean]* *[optional]*
* `silent` Whether to suppress output. *[boolean]* *[optional]*
* `disableNotification` Sends the message silently. *[boolean]* *[optional]*
* `template` Format output message. *[string]* *[optional]*
* `formatMessage` Format output message by own method. *[function]* *[optional]*
* `handleExceptions` Handle uncaught exceptions. *[boolean]* *[optional]*
* `batchingDelay` Time in ms within which to batch messages together. *[integer]* *[optional]* *[default 0 or disabled]*
* `batchingSeparator` String with which to join batched messages with *[string]* *[default "\n\n"]*

String template is based on named arguments:
``` js
Expand Down
Loading

0 comments on commit 3c25b8f

Please sign in to comment.