mir/node-telegram-bot-api
2
0
Fork 0
mirror of https://github.com/yagop/node-telegram-bot-api synced 2025-08-22 09:57:10 +00:00
Code Issues Releases Wiki Activity

doc: Improve deprecation messages

Browse Source
This commit is contained in:
GochoMugo 2017-12-20 12:12:01 +03:00
parent 4358f20dbb
commit 96c50ba1bd
No known key found for this signature in database
GPG Key ID: 7B6A01CB57AA39E4
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/telegram.js
View File

@ -300,6 +300,10 @@ class TelegramBot extends EventEmitter {
* @private * @private
*/ */
_formatSendData(type, data, fileOptions = {}) { _formatSendData(type, data, fileOptions = {}) {
const deprecationMessage =
'See https://github.com/yagop/node-telegram-bot-api/blob/master/doc/usage.md#sending-files' +
' for more information on how sending files has been improved and' +
' on how to disable this deprecation message altogether.';
let filedata = data; let filedata = data;
let filename = fileOptions.filename; let filename = fileOptions.filename;
let contentType = fileOptions.contentType; let contentType = fileOptions.contentType;
@ -315,7 +319,7 @@ class TelegramBot extends EventEmitter {
} }
} else if (Buffer.isBuffer(data)) { } else if (Buffer.isBuffer(data)) {
if (!filename && !process.env.NTBA_FIX_350) { if (!filename && !process.env.NTBA_FIX_350) {
deprecate('Buffers will have their filenames default to "filename" instead of "data".'); deprecate(`Buffers will have their filenames default to "filename" instead of "data". ${deprecationMessage}`);
filename = 'data'; filename = 'data';
} }
if (!contentType) { if (!contentType) {
@ -327,7 +331,7 @@ class TelegramBot extends EventEmitter {
filename = `${filename}.${ext}`; filename = `${filename}.${ext}`;
} }
} else if (!process.env.NTBA_FIX_350) { } else if (!process.env.NTBA_FIX_350) {
deprecate('An error will no longer be thrown if file-type of buffer could not be detected.'); deprecate(`An error will no longer be thrown if file-type of buffer could not be detected. ${deprecationMessage}`);
throw new errors.FatalError('Unsupported Buffer file-type'); throw new errors.FatalError('Unsupported Buffer file-type');
} }
} }
@ -349,7 +353,7 @@ class TelegramBot extends EventEmitter {
if (process.env.NTBA_FIX_350) { if (process.env.NTBA_FIX_350) {
contentType = contentType || 'application/octet-stream'; contentType = contentType || 'application/octet-stream';
} else { } else {
deprecate('In the future, content-type of files you send will default to "application/octet-stream".'); deprecate(`In the future, content-type of files you send will default to "application/octet-stream". ${deprecationMessage}`);
} }
// TODO: Add missing file extension. // TODO: Add missing file extension.
@ -390,7 +394,7 @@ class TelegramBot extends EventEmitter {
* @deprecated * @deprecated
*/ */
initPolling() { initPolling() {
deprecate('TelegramBot#initPolling() is deprecated'); deprecate('TelegramBot#initPolling() is deprecated. Use TelegramBot#startPolling() instead.');
return this.startPolling(); return this.startPolling();
} }