@slack/rtm-api - npm Package Compare versions

Comparing version 5.0.5 to 6.0.0

dist/index.d.ts

 /// <reference lib="es2017" />
 export { RTMClient, RTMClientOptions, RTMStartOptions, RTMCallResult, } from './RTMClient';
 export { Logger, LogLevel } from './logger';
-export { ErrorCode, RTMPlatformError, RTMWebsocketError, RTMNoReplyReceivedError, RTMSendWhileDisconnectedError, RTMSendWhileNotReadyError, RTMCallError, } from './errors';
+export { CodedError, ErrorCode, RTMPlatformError, RTMWebsocketError, RTMNoReplyReceivedError, RTMSendWhileDisconnectedError, RTMSendWhileNotReadyError, RTMCallError, } from './errors';
 //# sourceMappingURL=index.d.ts.map

dist/index.js

 "use strict";
 /// <reference lib="es2017" />
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorCode = exports.LogLevel = exports.RTMClient = void 0;
 var RTMClient_1 = require("./RTMClient");
@@ -5,0 +6,0 @@ Object.defineProperty(exports, "RTMClient", { enumerable: true, get: function () { return RTMClient_1.RTMClient; } });

dist/logger.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLogger = void 0;
+exports.getLogger = exports.LogLevel = void 0;
 const logger_1 = require("@slack/logger");
@@ -5,0 +5,0 @@ var logger_2 = require("@slack/logger");

dist/RTMClient.d.ts

@@ -113,4 +113,4 @@ /// <reference types="node" />
      * Send a simple message to a public channel, private channel, DM, or MPDM.
-     * @param text The message text.
-     * @param conversationId A conversation ID for the destination of this message.
+     * @param text - The message text.
+     * @param conversationId - A conversation ID for the destination of this message.
      */
@@ -120,3 +120,3 @@ sendMessage(text: string, conversationId: string): Promise<RTMCallResult>;
      * Sends a typing indicator to indicate that the user with `activeUserId` is typing.
-     * @param conversationId The destination for where the typing indicator should be shown.
+     * @param conversationId - The destination for where the typing indicator should be shown.
      */
@@ -126,4 +126,4 @@ sendTyping(conversationId: string): Promise<void>;
      * Subscribes this client to presence changes for only the given `userIds`.
-     * @param userIds An array of user IDs whose presence you are interested in. This list will replace the list from any
-     * previous calls to this method.
+     * @param userIds - An array of user IDs whose presence you are interested in. This list will replace the list from
+     * any previous calls to this method.
      */
@@ -144,6 +144,6 @@ subscribePresence(userIds: string[]): Promise<void>;
      *
-     * @param awaitReply whether to wait for an acknowledgement response from the platform before resolving the returned
+     * @param awaitReply - whether to wait for an acknowledgement response from the platform before resolving the returned
      * Promise.
-     * @param type the message type
-     * @param body the message body
+     * @param type - the message type
+     * @param body - the message body
      */
@@ -158,4 +158,4 @@ addOutgoingEvent(awaitReply: true, type: string, body?: {}): Promise<RTMCallResult>;
      * there is `ts` on messages once the server acknowledges it).
-     * @param type the message type
-     * @param body the message body
+     * @param type - the message type
+     * @param body - the message body
      */
@@ -162,0 +162,0 @@ send(type: string, body?: {}): Promise<number>;

dist/RTMClient.js

@@ -35,2 +35,7 @@ "use strict";
         /**
+         * The number of milliseconds to wait upon connection for reply messages from the previous connection. The default
+         * value is 2 seconds.
+         */
+        this.replyAckOnReconnectTimeout = 2000;
+        /**
          * Configuration for the state machine
@@ -294,4 +299,4 @@ */
      * Send a simple message to a public channel, private channel, DM, or MPDM.
-     * @param text The message text.
-     * @param conversationId A conversation ID for the destination of this message.
+     * @param text - The message text.
+     * @param conversationId - A conversation ID for the destination of this message.
      */
@@ -303,3 +308,3 @@ async sendMessage(text, conversationId) {
      * Sends a typing indicator to indicate that the user with `activeUserId` is typing.
-     * @param conversationId The destination for where the typing indicator should be shown.
+     * @param conversationId - The destination for where the typing indicator should be shown.
      */
@@ -311,4 +316,4 @@ sendTyping(conversationId) {
      * Subscribes this client to presence changes for only the given `userIds`.
-     * @param userIds An array of user IDs whose presence you are interested in. This list will replace the list from any
-     * previous calls to this method.
+     * @param userIds - An array of user IDs whose presence you are interested in. This list will replace the list from
+     * any previous calls to this method.
      */
@@ -355,4 +360,4 @@ subscribePresence(userIds) {
      * there is `ts` on messages once the server acknowledges it).
-     * @param type the message type
-     * @param body the message body
+     * @param type - the message type
+     * @param body - the message body
      */
@@ -359,0 +364,0 @@ send(type, body = {}) {

package.json

 {
   "name": "@slack/rtm-api",
-  "version": "5.0.5",
+  "version": "6.0.0",
   "description": "Official library for using the Slack Platform's Real Time Messaging API",
@@ -25,4 +25,4 @@ "author": "Slack Technologies, Inc.",
   "engines": {
-    "node": ">= 8.9.0",
-    "npm": ">= 5.5.1"
+    "node": ">= 12.13.0",
+    "npm": ">= 6.12.0"
   },
@@ -42,3 +42,4 @@ "repository": "slackapi/node-slack-sdk",
     "lint": "tslint --project .",
-    "test": "npm run build && echo \"Tests are not implemented.\" && exit 0"
+    "test": "npm run build && echo \"Tests are not implemented.\" && exit 0",
+    "ref-docs:model": "api-extractor run"
   },
@@ -48,3 +49,3 @@ "dependencies": {
     "@slack/web-api": "^5.3.0",
-    "@types/node": ">=8.9.0",
+    "@types/node": ">=12.0.0",
     "@types/p-queue": "^2.3.2",
@@ -59,7 +60,8 @@ "@types/ws": "^7.2.5",
   "devDependencies": {
+    "@microsoft/api-extractor": "^7.3.4",
     "shx": "^0.3.2",
     "tslint": "^5.13.1",
     "tslint-config-airbnb": "^5.11.1",
-    "typescript": "^3.3.3333"
+    "typescript": "^4.1.0"
   }
 }

README.md

 # Slack Real Time Messaging API
 
-<!-- TODO: per-job badge https://github.com/bjfish/travis-matrix-badges/issues/4 -->
-[![Build Status](https://travis-ci.org/slackapi/node-slack-sdk.svg?branch=master)](https://travis-ci.org/slackapi/node-slack-sdk)
+[![build-ci](https://github.com/slackapi/node-slack-sdk/workflows/CI%20Build/badge.svg)](https://github.com/slackapi/node-slack-sdk/actions?query=workflow%3A%22CI+Build%22)
 <!-- TODO: per-flag badge https://docs.codecov.io/docs/flags#section-flag-badges-and-graphs -->
@@ -6,0 +5,0 @@ [![codecov](https://codecov.io/gh/slackapi/node-slack-sdk/branch/master/graph/badge.svg)](https://codecov.io/gh/slackapi/node-slack-sdk)

No alert changes

Improved metrics

Total package byte prevSize

97540

0.46%

Lines of code

1131

0.53%

Worsened metrics

Dev dependency count

5

25%

Number of lines in readme file

451

-0.22%

Dependency changes

• Updated

  @types/node@>=12.0.0