gitea
/
node-telegram-bot-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Fix documented types for params `chatId`, `userId`

Browse Source 
References:

  * BR: https://github.com/yagop/node-telegram-bot-api/issues/300
release
GochoMugo 8 years ago
parent 633bd83a0a
commit 1f61b82aa8
No known key found for this signature in database
GPG Key ID: 7B6A01CB57AA39E4
2 changed files with 18 additions and 18 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 18
      doc/api.md
  2. 18
      src/telegram.js

18
doc/api.md
Unescape View File

@ -443,7 +443,7 @@ Returns True on success.
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target group or username of the target supergroup | | chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target group or username of the target supergroup |
| userId | <code>String</code> | Unique identifier of the target user | | userId | <code>Number</code> | Unique identifier of the target user |
<a name="TelegramBot+unbanChatMember"></a> <a name="TelegramBot+unbanChatMember"></a>
@ -459,7 +459,7 @@ the group for this to work. Returns True on success.
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target group or username of the target supergroup | | chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target group or username of the target supergroup |
| userId | <code>String</code> | Unique identifier of the target user | | userId | <code>Number</code> | Unique identifier of the target user |
<a name="TelegramBot+restrictChatMember"></a> <a name="TelegramBot+restrictChatMember"></a>
@ -475,7 +475,7 @@ to lift restrictions from a user. Returns True on success.
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target chat or username of the target supergroup | | chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target chat or username of the target supergroup |
| userId | <code>String</code> | Unique identifier of the target user | | userId | <code>Number</code> | Unique identifier of the target user |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
<a name="TelegramBot+promoteChatMember"></a> <a name="TelegramBot+promoteChatMember"></a>
@ -492,7 +492,7 @@ Returns True on success.
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target chat or username of the target supergroup | | chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target chat or username of the target supergroup |
| userId | <code>String</code> | | | userId | <code>Number</code> | |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
<a name="TelegramBot+exportChatInviteLink"></a> <a name="TelegramBot+exportChatInviteLink"></a>
@ -683,7 +683,7 @@ that is being deprecated.
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| userId | <code>Number</code> &#124; <code>String</code> | Unique identifier of the target user | | userId | <code>Number</code> | Unique identifier of the target user |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
<a name="TelegramBot+sendLocation"></a> <a name="TelegramBot+sendLocation"></a>
@ -885,7 +885,7 @@ Use this method to get information about a member of a chat.
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target group or username of the target supergroup | | chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier for the target group or username of the target supergroup |
| userId | <code>String</code> | Unique identifier of the target user | | userId | <code>Number</code> | Unique identifier of the target user |
<a name="TelegramBot+leaveChat"></a> <a name="TelegramBot+leaveChat"></a>
@ -923,7 +923,7 @@ Use this method to set the score of the specified user in a game.
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| userId | <code>String</code> | Unique identifier of the target user | | userId | <code>Number</code> | Unique identifier of the target user |
| score | <code>Number</code> | New score value. | | score | <code>Number</code> | New score value. |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
@ -937,7 +937,7 @@ Use this method to get data for high score table.
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| userId | <code>String</code> | Unique identifier of the target user | | userId | <code>Number</code> | Unique identifier of the target user |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |
<a name="TelegramBot+deleteMessage"></a> <a name="TelegramBot+deleteMessage"></a>
@ -950,7 +950,7 @@ Use this method to delete a message.
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| chatId | <code>String</code> | Unique identifier of the target chat | | chatId | <code>Number</code> &#124; <code>String</code> | Unique identifier of the target chat |
| messageId | <code>String</code> | Unique identifier of the target message | | messageId | <code>String</code> | Unique identifier of the target message |
| [options] | <code>Object</code> | Additional Telegram query options | | [options] | <code>Object</code> | Additional Telegram query options |

18
src/telegram.js
Unescape View File

@ -861,7 +861,7 @@ class TelegramBot extends EventEmitter {
* Returns True on success. * Returns True on success.
* *
* @param {Number|String} chatId Unique identifier for the target group or username of the target supergroup * @param {Number|String} chatId Unique identifier for the target group or username of the target supergroup
* @param {String} userId Unique identifier of the target user * @param {Number} userId Unique identifier of the target user
* @return {Promise} * @return {Promise}
* @see https://core.telegram.org/bots/api#kickchatmember * @see https://core.telegram.org/bots/api#kickchatmember
*/ */
@ -880,7 +880,7 @@ class TelegramBot extends EventEmitter {
* the group for this to work. Returns True on success. * the group for this to work. Returns True on success.
* *
* @param {Number|String} chatId Unique identifier for the target group or username of the target supergroup * @param {Number|String} chatId Unique identifier for the target group or username of the target supergroup
* @param {String} userId Unique identifier of the target user * @param {Number} userId Unique identifier of the target user
* @return {Promise} * @return {Promise}
* @see https://core.telegram.org/bots/api#unbanchatmember * @see https://core.telegram.org/bots/api#unbanchatmember
*/ */
@ -899,7 +899,7 @@ class TelegramBot extends EventEmitter {
* to lift restrictions from a user. Returns True on success. * to lift restrictions from a user. Returns True on success.
* *
* @param {Number|String} chatId Unique identifier for the target chat or username of the target supergroup * @param {Number|String} chatId Unique identifier for the target chat or username of the target supergroup
* @param {String} userId Unique identifier of the target user * @param {Number} userId Unique identifier of the target user
* @param {Object} [options] Additional Telegram query options * @param {Object} [options] Additional Telegram query options
* @return {Promise} * @return {Promise}
* @see https://core.telegram.org/bots/api#restrictchatmember * @see https://core.telegram.org/bots/api#restrictchatmember
@ -917,7 +917,7 @@ class TelegramBot extends EventEmitter {
* Returns True on success. * Returns True on success.
* *
* @param {Number|String} chatId Unique identifier for the target chat or username of the target supergroup * @param {Number|String} chatId Unique identifier for the target chat or username of the target supergroup
* @param {String} userId * @param {Number} userId
* @param {Object} [options] Additional Telegram query options * @param {Object} [options] Additional Telegram query options
* @return {Promise} * @return {Promise}
* @see https://core.telegram.org/bots/api#promotechatmember * @see https://core.telegram.org/bots/api#promotechatmember
@ -1145,7 +1145,7 @@ class TelegramBot extends EventEmitter {
* This method has an [older, compatible signature][getUserProfilePhotos-v0.25.0] * This method has an [older, compatible signature][getUserProfilePhotos-v0.25.0]
* that is being deprecated. * that is being deprecated.
* *
* @param {Number|String} userId Unique identifier of the target user * @param {Number} userId Unique identifier of the target user
* @param {Object} [options] Additional Telegram query options * @param {Object} [options] Additional Telegram query options
* @return {Promise} * @return {Promise}
* @see https://core.telegram.org/bots/api#getuserprofilephotos * @see https://core.telegram.org/bots/api#getuserprofilephotos
@ -1389,7 +1389,7 @@ class TelegramBot extends EventEmitter {
/** /**
* Use this method to get information about a member of a chat. * Use this method to get information about a member of a chat.
* @param {Number|String} chatId Unique identifier for the target group or username of the target supergroup * @param {Number|String} chatId Unique identifier for the target group or username of the target supergroup
* @param {String} userId Unique identifier of the target user * @param {Number} userId Unique identifier of the target user
* @return {Promise} * @return {Promise}
* @see https://core.telegram.org/bots/api#getchatmember * @see https://core.telegram.org/bots/api#getchatmember
*/ */
@ -1430,7 +1430,7 @@ class TelegramBot extends EventEmitter {
/** /**
* Use this method to set the score of the specified user in a game. * Use this method to set the score of the specified user in a game.
* @param {String} userId Unique identifier of the target user * @param {Number} userId Unique identifier of the target user
* @param {Number} score New score value. * @param {Number} score New score value.
* @param {Object} [options] Additional Telegram query options * @param {Object} [options] Additional Telegram query options
* @return {Promise} * @return {Promise}
@ -1444,7 +1444,7 @@ class TelegramBot extends EventEmitter {
/** /**
* Use this method to get data for high score table. * Use this method to get data for high score table.
* @param {String} userId Unique identifier of the target user * @param {Number} userId Unique identifier of the target user
* @param {Object} [options] Additional Telegram query options * @param {Object} [options] Additional Telegram query options
* @return {Promise} * @return {Promise}
* @see https://core.telegram.org/bots/api#getgamehighscores * @see https://core.telegram.org/bots/api#getgamehighscores
@ -1456,7 +1456,7 @@ class TelegramBot extends EventEmitter {
/** /**
* Use this method to delete a message. * Use this method to delete a message.
* @param {String} chatId Unique identifier of the target chat * @param {Number|String} chatId Unique identifier of the target chat
* @param {String} messageId Unique identifier of the target message * @param {String} messageId Unique identifier of the target message
* @param {Object} [options] Additional Telegram query options * @param {Object} [options] Additional Telegram query options
* @return {Promise} * @return {Promise}

Write Preview
Loading…
Cancel
Save