Codacy suggestions

Author: Mohit Tejani

docs-snippets/basic-usage/file-sharing.ts

@@ -90,7 +90,7 @@ try {
     }`,
   );
 }
-let fileContent = await file!.toBlob();
+const fileContent = await file!.toBlob();
 // snippet.end
 
 // snippet.deleteFileBasicUsage

docs-snippets/basic-usage/publish-subscribe.ts

@@ -139,4 +139,4 @@ pubnub.unsubscribe({
 
 // snippet.OLDUnsubscribeAllBasicUsage
 pubnub.unsubscribeAll();
-// snippet.end  
+// snippet.end

docs-snippets/configuration.ts

@@ -4,48 +4,48 @@ import PubNub from '../lib/types';
 // encrypts using 256-bit AES-CBC cipher (recommended)
 // decrypts data encrypted with the legacy and the 256 bit AES-CBC ciphers
 const pubnub = new PubNub({
-    subscribeKey: 'YOUR_SUBSCRIBE_KEY',
-    userId: 'YOUR_USER_ID',
-    cryptoModule: PubNub.CryptoModule.aesCbcCryptoModule({cipherKey: 'pubnubenigma'})
-  });
-  
-  // encrypts with 128-bit cipher key entropy (legacy)
-  // decrypts data encrypted with the legacy and the 256-bit AES-CBC ciphers
+  subscribeKey: 'YOUR_SUBSCRIBE_KEY',
+  userId: 'YOUR_USER_ID',
+  cryptoModule: PubNub.CryptoModule.aesCbcCryptoModule({ cipherKey: 'pubnubenigma' }),
+});
+
+// encrypts with 128-bit cipher key entropy (legacy)
+// decrypts data encrypted with the legacy and the 256-bit AES-CBC ciphers
 const pubnubLegacy = new PubNub({
-    subscribeKey: 'YOUR_SUBSCRIBE_KEY',
-    userId: 'YOUR_USER_ID',
-    cryptoModule: PubNub.CryptoModule.legacyCryptoModule({cipherKey: 'pubnubenigma'})
-  });
+  subscribeKey: 'YOUR_SUBSCRIBE_KEY',
+  userId: 'YOUR_USER_ID',
+  cryptoModule: PubNub.CryptoModule.legacyCryptoModule({ cipherKey: 'pubnubenigma' }),
+});
 // snippet.end
 
 // snippet.configurationServerOpertaion
 const pubnubServer = new PubNub({
-    subscribeKey: "mySubscribeKey",
-    publishKey: "myPublishKey",
-    userId: "myUniqueUserId",
-    secretKey: "secretKey",
-    heartbeatInterval: 0
+  subscribeKey: 'mySubscribeKey',
+  publishKey: 'myPublishKey',
+  userId: 'myUniqueUserId',
+  secretKey: 'secretKey',
+  heartbeatInterval: 0,
 });
 // snippet.end
 
 // snippet.configurationRealOnlyClient
 // Initialize for Read Only Client
 
 const pubnubReadOnly = new PubNub({
-    subscribeKey: "mySubscribeKey",
-    userId: "myUniqueUserId"
+  subscribeKey: 'mySubscribeKey',
+  userId: 'myUniqueUserId',
 });
 // snippet.end
 
 // snippet.configurationSSLEnabled
 const pubnubSSL = new PubNub({
-    subscribeKey: "mySubscribeKey",
-    publishKey: "myPublishKey",
-    cryptoModule: PubNub.CryptoModule.aesCbcCryptoModule({cipherKey: 'pubnubenigma'}),
-    authKey: "myAuthKey",
-    logLevel: PubNub.LogLevel.Debug,
-    userId: "myUniqueUserId",
-    ssl: true
+  subscribeKey: 'mySubscribeKey',
+  publishKey: 'myPublishKey',
+  cryptoModule: PubNub.CryptoModule.aesCbcCryptoModule({ cipherKey: 'pubnubenigma' }),
+  authKey: 'myAuthKey',
+  logLevel: PubNub.LogLevel.Debug,
+  userId: 'myUniqueUserId',
+  ssl: true,
 });
 // snippet.end
 

docs-snippets/file-sharing.ts

@@ -32,4 +32,4 @@ const file = await pubnub.downloadFile({
   name: 'cat_picture.jpg',
   cipherKey: 'myCipherKey',
 });
-// snippet.end
+// snippet.end

docs-snippets/getting-started.ts

@@ -2,43 +2,43 @@ import PubNub, { Subscription } from '../lib/types';
 
 // snippet.gettingStartedInitPubnub
 const pubnub = new PubNub({
-    publishKey: 'YOUR_PUBLISH_KEY',
-    subscribeKey: 'YOUR_SUBSCRIBE_KEY',
-    userId: 'YOUR_USER_ID'
+  publishKey: 'YOUR_PUBLISH_KEY',
+  subscribeKey: 'YOUR_SUBSCRIBE_KEY',
+  userId: 'YOUR_USER_ID',
 });
 // snippet.end
 
 // snippet.gettingStartedEventListeners
 // Add listener to handle messages, presence events, and connection status
 pubnub.addListener({
-    message: function(event: Subscription.Message) {
-        // Handle message event
-        console.log("New message:", event.message);
-        // Format and display received message
-        const displayText = (() => {
-            if (typeof event.message === 'object' && event.message && 'text' in event.message) {
-                const messageObj = event.message as { text?: string; sender?: string };
-                return `${messageObj.sender || 'User'}: ${messageObj.text}`;
-            } else {
-                return `Message: ${JSON.stringify(event.message)}`;
-            }
-        })();
-        console.log(displayText);
-    },
-    presence: function(event: Subscription.Presence) {
-        // Handle presence event
-        console.log("Presence event:", event);
-        console.log("Action:", event.action); // join, leave, timeout
-        console.log("Channel:", event.channel);
-    },
-    status: function(event) {
-        // Handle status event
-        if (event.category === "PNConnectedCategory") {
-            console.log("Connected to PubNub chat!");
-        } else if (event.category === "PNNetworkIssuesCategory") {
-            console.log("Connection lost. Attempting to reconnect...");
-        }
+  message: function (event: Subscription.Message) {
+    // Handle message event
+    console.log('New message:', event.message);
+    // Format and display received message
+    const displayText = (() => {
+      if (typeof event.message === 'object' && event.message && 'text' in event.message) {
+        const messageObj = event.message as { text?: string; sender?: string };
+        return `${messageObj.sender || 'User'}: ${messageObj.text}`;
+      } else {
+        return `Message: ${JSON.stringify(event.message)}`;
+      }
+    })();
+    console.log(displayText);
+  },
+  presence: function (event: Subscription.Presence) {
+    // Handle presence event
+    console.log('Presence event:', event);
+    console.log('Action:', event.action); // join, leave, timeout
+    console.log('Channel:', event.channel);
+  },
+  status: function (event) {
+    // Handle status event
+    if (event.category === 'PNConnectedCategory') {
+      console.log('Connected to PubNub chat!');
+    } else if (event.category === 'PNNetworkIssuesCategory') {
+      console.log('Connection lost. Attempting to reconnect...');
     }
+  },
 });
 // snippet.end
 
@@ -48,7 +48,7 @@ const channel = pubnub.channel('hello_world');
 
 // Create a subscription
 const subscription = channel.subscription({
-    receivePresenceEvents: true // to receive presence events
+  receivePresenceEvents: true, // to receive presence events
 });
 
 // Subscribe
@@ -58,26 +58,26 @@ subscription.subscribe();
 // snippet.gettingStartedPublishMessages
 // Function to publish a message
 async function publishMessage(text: string) {
-    if (!text.trim()) return;
-    
-    try {
-        const result = await pubnub.publish({
-            message: {
-                text: text,
-                sender: pubnub.userId,
-                time: new Date().toISOString()
-            },
-            channel: 'hello_world'
-        });
-        console.log(`Message published with timetoken: ${result.timetoken}`);
-        console.log(`You: ${text}`);
-    } catch (error) {
-        console.error(`Publish failed: ${error}`);
-    }
+  if (!text.trim()) return;
+
+  try {
+    const result = await pubnub.publish({
+      message: {
+        text: text,
+        sender: pubnub.userId,
+        time: new Date().toISOString(),
+      },
+      channel: 'hello_world',
+    });
+    console.log(`Message published with timetoken: ${result.timetoken}`);
+    console.log(`You: ${text}`);
+  } catch (error) {
+    console.error(`Publish failed: ${error}`);
+  }
 }
 
 // Example: publish a message
-const text_message = "Hello, world!";
+const text_message = 'Hello, world!';
 publishMessage(text_message);
 
 // snippet.end

docs-snippets/import-pubnub.ts

@@ -9,8 +9,8 @@ import fs from 'fs';
 // snippet.PubNubinitBasicUsage
 // Initialize PubNub with your keys
 const pubnub = new PubNub({
-    publishKey: 'YOUR_PUBLISH_KEY',
-    subscribeKey: 'YOUR_SUBSCRIBE_KEY',
-    userId: 'YOUR_USER_ID',
-  });
+  publishKey: 'YOUR_PUBLISH_KEY',
+  subscribeKey: 'YOUR_SUBSCRIBE_KEY',
+  userId: 'YOUR_USER_ID',
+});
 // snippet.end

docs-snippets/presence.ts

@@ -8,36 +8,35 @@ const pubnub = new PubNub({
 
 // snippet.hereNowWithState
 try {
-    const response = await pubnub.hereNow({
-        channels: ['my_channel'],
-        includeState: true,
-    });
-    console.log(`hereNow response: ${response}`);
+  const response = await pubnub.hereNow({
+    channels: ['my_channel'],
+    includeState: true,
+  });
+  console.log(`hereNow response: ${response}`);
 } catch (status) {
-    console.log(`hereNow failed with error: ${status}`);
+  console.log(`hereNow failed with error: ${status}`);
 }
 // snippet.end
 
 // snippet.hereNowFetchOccupancyOnly
 try {
-    const response = await pubnub.hereNow({
-        channels: ['my_channel'],
-        includeUUIDs: false,
-    });
-    console.log(`hereNow response: ${response}`);
+  const response = await pubnub.hereNow({
+    channels: ['my_channel'],
+    includeUUIDs: false,
+  });
+  console.log(`hereNow response: ${response}`);
 } catch (status) {
-    console.log(`hereNow failed with error: ${status}`);
+  console.log(`hereNow failed with error: ${status}`);
 }
 // snippet.end
 
-
 // snippet.hereNowChannelGroup
 try {
-    const response = await pubnub.hereNow({
-        channelGroups: ['my_channel_group'],
-    });
-    console.log(`hereNow response: ${response}`);
+  const response = await pubnub.hereNow({
+    channelGroups: ['my_channel_group'],
+  });
+  console.log(`hereNow response: ${response}`);
 } catch (status) {
-    console.log(`hereNow failed with error: ${status}`);
+  console.log(`hereNow failed with error: ${status}`);
 }
-// snippet.end
+// snippet.end

docs-snippets/publish-subscribe.ts

@@ -257,4 +257,4 @@ pubnub.unsubscribe({
   // remove a subscription set from another subscription set
   subscriptionSet1.removeSubscriptionSet(subscriptionSet2);
   // snippet.end
-}
+}