[docs] Mention auto-deletion of webhook during polling

experimental
GochoMugo 9 years ago
parent 2a782fddbc
commit 4735518116
No known key found for this signature in database
GPG Key ID: 7B6A01CB57AA39E4
  1. 2
      README.md
  2. 3
      src/telegram.js

@ -129,7 +129,7 @@ Emits `message` when a message arrives.
| --- | --- | --- | --- | | --- | --- | --- | --- |
| token | <code>String</code> | | Bot Token | | token | <code>String</code> | | Bot Token |
| [options] | <code>Object</code> | | | | [options] | <code>Object</code> | | |
| [options.polling] | <code>Boolean</code> &#124; <code>Object</code> | <code>false</code> | Set true to enable polling or set options | | [options.polling] | <code>Boolean</code> &#124; <code>Object</code> | <code>false</code> | Set true to enable polling or set options. If a WebHook has been set, it will be deleted automatically. |
| [options.polling.timeout] | <code>String</code> &#124; <code>Number</code> | <code>10</code> | Timeout in seconds for long polling | | [options.polling.timeout] | <code>String</code> &#124; <code>Number</code> | <code>10</code> | Timeout in seconds for long polling |
| [options.polling.interval] | <code>String</code> &#124; <code>Number</code> | <code>300</code> | Interval between requests in miliseconds | | [options.polling.interval] | <code>String</code> &#124; <code>Number</code> | <code>300</code> | Interval between requests in miliseconds |
| [options.polling.autoStart] | <code>Boolean</code> | <code>true</code> | Start polling immediately | | [options.polling.autoStart] | <code>Boolean</code> | <code>true</code> | Start polling immediately |

@ -41,7 +41,8 @@ class TelegramBot extends EventEmitter {
* @constructor * @constructor
* @param {String} token Bot Token * @param {String} token Bot Token
* @param {Object} [options] * @param {Object} [options]
* @param {Boolean|Object} [options.polling=false] Set true to enable polling or set options * @param {Boolean|Object} [options.polling=false] Set true to enable polling or set options.
* If a WebHook has been set, it will be deleted automatically.
* @param {String|Number} [options.polling.timeout=10] Timeout in seconds for long polling * @param {String|Number} [options.polling.timeout=10] Timeout in seconds for long polling
* @param {String|Number} [options.polling.interval=300] Interval between requests in miliseconds * @param {String|Number} [options.polling.interval=300] Interval between requests in miliseconds
* @param {Boolean} [options.polling.autoStart=true] Start polling immediately * @param {Boolean} [options.polling.autoStart=true] Start polling immediately

Loading…
Cancel
Save