Skip to content

Commit 133b270

Browse files
Mohit TejaniMohit Tejani
Mohit Tejani
authored and
Mohit Tejani
committed
Codacy suggestions
1 parent aab00bd commit 133b270

File tree

8 files changed

+99
-100
lines changed

8 files changed

+99
-100
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ try {
9090
}`,
9191
);
9292
}
93-
let fileContent = await file!.toBlob();
93+
const fileContent = await file!.toBlob();
9494
// snippet.end
9595

9696
// snippet.deleteFileBasicUsage

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,4 +139,4 @@ pubnub.unsubscribe({
139139

140140
// snippet.OLDUnsubscribeAllBasicUsage
141141
pubnub.unsubscribeAll();
142-
// snippet.end
142+
// snippet.end

‎docs-snippets/configuration.ts‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,48 +4,48 @@ import PubNub from '../lib/types';
44
// encrypts using 256-bit AES-CBC cipher (recommended)
55
// decrypts data encrypted with the legacy and the 256 bit AES-CBC ciphers
66
const pubnub = new PubNub({
7-
subscribeKey: 'YOUR_SUBSCRIBE_KEY',
8-
userId: 'YOUR_USER_ID',
9-
cryptoModule: PubNub.CryptoModule.aesCbcCryptoModule({cipherKey: 'pubnubenigma'})
10-
});
11-
12-
// encrypts with 128-bit cipher key entropy (legacy)
13-
// decrypts data encrypted with the legacy and the 256-bit AES-CBC ciphers
7+
subscribeKey: 'YOUR_SUBSCRIBE_KEY',
8+
userId: 'YOUR_USER_ID',
9+
cryptoModule: PubNub.CryptoModule.aesCbcCryptoModule({ cipherKey: 'pubnubenigma' }),
10+
});
11+
12+
// encrypts with 128-bit cipher key entropy (legacy)
13+
// decrypts data encrypted with the legacy and the 256-bit AES-CBC ciphers
1414
const pubnubLegacy = new PubNub({
15-
subscribeKey: 'YOUR_SUBSCRIBE_KEY',
16-
userId: 'YOUR_USER_ID',
17-
cryptoModule: PubNub.CryptoModule.legacyCryptoModule({cipherKey: 'pubnubenigma'})
18-
});
15+
subscribeKey: 'YOUR_SUBSCRIBE_KEY',
16+
userId: 'YOUR_USER_ID',
17+
cryptoModule: PubNub.CryptoModule.legacyCryptoModule({ cipherKey: 'pubnubenigma' }),
18+
});
1919
// snippet.end
2020

2121
// snippet.configurationServerOpertaion
2222
const pubnubServer = new PubNub({
23-
subscribeKey: "mySubscribeKey",
24-
publishKey: "myPublishKey",
25-
userId: "myUniqueUserId",
26-
secretKey: "secretKey",
27-
heartbeatInterval: 0
23+
subscribeKey: 'mySubscribeKey',
24+
publishKey: 'myPublishKey',
25+
userId: 'myUniqueUserId',
26+
secretKey: 'secretKey',
27+
heartbeatInterval: 0,
2828
});
2929
// snippet.end
3030

3131
// snippet.configurationRealOnlyClient
3232
// Initialize for Read Only Client
3333

3434
const pubnubReadOnly = new PubNub({
35-
subscribeKey: "mySubscribeKey",
36-
userId: "myUniqueUserId"
35+
subscribeKey: 'mySubscribeKey',
36+
userId: 'myUniqueUserId',
3737
});
3838
// snippet.end
3939

4040
// snippet.configurationSSLEnabled
4141
const pubnubSSL = new PubNub({
42-
subscribeKey: "mySubscribeKey",
43-
publishKey: "myPublishKey",
44-
cryptoModule: PubNub.CryptoModule.aesCbcCryptoModule({cipherKey: 'pubnubenigma'}),
45-
authKey: "myAuthKey",
46-
logLevel: PubNub.LogLevel.Debug,
47-
userId: "myUniqueUserId",
48-
ssl: true
42+
subscribeKey: 'mySubscribeKey',
43+
publishKey: 'myPublishKey',
44+
cryptoModule: PubNub.CryptoModule.aesCbcCryptoModule({ cipherKey: 'pubnubenigma' }),
45+
authKey: 'myAuthKey',
46+
logLevel: PubNub.LogLevel.Debug,
47+
userId: 'myUniqueUserId',
48+
ssl: true,
4949
});
5050
// snippet.end
5151

‎docs-snippets/file-sharing.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ const file = await pubnub.downloadFile({
3232
name: 'cat_picture.jpg',
3333
cipherKey: 'myCipherKey',
3434
});
35-
// snippet.end
35+
// snippet.end

‎docs-snippets/getting-started.ts‎

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,43 @@ import PubNub, { Subscription } from '../lib/types';
22

33
// snippet.gettingStartedInitPubnub
44
const pubnub = new PubNub({
5-
publishKey: 'YOUR_PUBLISH_KEY',
6-
subscribeKey: 'YOUR_SUBSCRIBE_KEY',
7-
userId: 'YOUR_USER_ID'
5+
publishKey: 'YOUR_PUBLISH_KEY',
6+
subscribeKey: 'YOUR_SUBSCRIBE_KEY',
7+
userId: 'YOUR_USER_ID',
88
});
99
// snippet.end
1010

1111
// snippet.gettingStartedEventListeners
1212
// Add listener to handle messages, presence events, and connection status
1313
pubnub.addListener({
14-
message: function(event: Subscription.Message) {
15-
// Handle message event
16-
console.log("New message:", event.message);
17-
// Format and display received message
18-
const displayText = (() => {
19-
if (typeof event.message === 'object' && event.message && 'text' in event.message) {
20-
const messageObj = event.message as { text?: string; sender?: string };
21-
return `${messageObj.sender || 'User'}: ${messageObj.text}`;
22-
} else {
23-
return `Message: ${JSON.stringify(event.message)}`;
24-
}
25-
})();
26-
console.log(displayText);
27-
},
28-
presence: function(event: Subscription.Presence) {
29-
// Handle presence event
30-
console.log("Presence event:", event);
31-
console.log("Action:", event.action); // join, leave, timeout
32-
console.log("Channel:", event.channel);
33-
},
34-
status: function(event) {
35-
// Handle status event
36-
if (event.category === "PNConnectedCategory") {
37-
console.log("Connected to PubNub chat!");
38-
} else if (event.category === "PNNetworkIssuesCategory") {
39-
console.log("Connection lost. Attempting to reconnect...");
40-
}
14+
message: function (event: Subscription.Message) {
15+
// Handle message event
16+
console.log('New message:', event.message);
17+
// Format and display received message
18+
const displayText = (() => {
19+
if (typeof event.message === 'object' && event.message && 'text' in event.message) {
20+
const messageObj = event.message as { text?: string; sender?: string };
21+
return `${messageObj.sender || 'User'}: ${messageObj.text}`;
22+
} else {
23+
return `Message: ${JSON.stringify(event.message)}`;
24+
}
25+
})();
26+
console.log(displayText);
27+
},
28+
presence: function (event: Subscription.Presence) {
29+
// Handle presence event
30+
console.log('Presence event:', event);
31+
console.log('Action:', event.action); // join, leave, timeout
32+
console.log('Channel:', event.channel);
33+
},
34+
status: function (event) {
35+
// Handle status event
36+
if (event.category === 'PNConnectedCategory') {
37+
console.log('Connected to PubNub chat!');
38+
} else if (event.category === 'PNNetworkIssuesCategory') {
39+
console.log('Connection lost. Attempting to reconnect...');
4140
}
41+
},
4242
});
4343
// snippet.end
4444

@@ -48,7 +48,7 @@ const channel = pubnub.channel('hello_world');
4848

4949
// Create a subscription
5050
const subscription = channel.subscription({
51-
receivePresenceEvents: true // to receive presence events
51+
receivePresenceEvents: true, // to receive presence events
5252
});
5353

5454
// Subscribe
@@ -58,26 +58,26 @@ subscription.subscribe();
5858
// snippet.gettingStartedPublishMessages
5959
// Function to publish a message
6060
async function publishMessage(text: string) {
61-
if (!text.trim()) return;
62-
63-
try {
64-
const result = await pubnub.publish({
65-
message: {
66-
text: text,
67-
sender: pubnub.userId,
68-
time: new Date().toISOString()
69-
},
70-
channel: 'hello_world'
71-
});
72-
console.log(`Message published with timetoken: ${result.timetoken}`);
73-
console.log(`You: ${text}`);
74-
} catch (error) {
75-
console.error(`Publish failed: ${error}`);
76-
}
61+
if (!text.trim()) return;
62+
63+
try {
64+
const result = await pubnub.publish({
65+
message: {
66+
text: text,
67+
sender: pubnub.userId,
68+
time: new Date().toISOString(),
69+
},
70+
channel: 'hello_world',
71+
});
72+
console.log(`Message published with timetoken: ${result.timetoken}`);
73+
console.log(`You: ${text}`);
74+
} catch (error) {
75+
console.error(`Publish failed: ${error}`);
76+
}
7777
}
7878

7979
// Example: publish a message
80-
const text_message = "Hello, world!";
80+
const text_message = 'Hello, world!';
8181
publishMessage(text_message);
8282

8383
// snippet.end

‎docs-snippets/import-pubnub.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ import fs from 'fs';
99
// snippet.PubNubinitBasicUsage
1010
// Initialize PubNub with your keys
1111
const pubnub = new PubNub({
12-
publishKey: 'YOUR_PUBLISH_KEY',
13-
subscribeKey: 'YOUR_SUBSCRIBE_KEY',
14-
userId: 'YOUR_USER_ID',
15-
});
12+
publishKey: 'YOUR_PUBLISH_KEY',
13+
subscribeKey: 'YOUR_SUBSCRIBE_KEY',
14+
userId: 'YOUR_USER_ID',
15+
});
1616
// snippet.end

‎docs-snippets/presence.ts‎

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,36 +8,35 @@ const pubnub = new PubNub({
88

99
// snippet.hereNowWithState
1010
try {
11-
const response = await pubnub.hereNow({
12-
channels: ['my_channel'],
13-
includeState: true,
14-
});
15-
console.log(`hereNow response: ${response}`);
11+
const response = await pubnub.hereNow({
12+
channels: ['my_channel'],
13+
includeState: true,
14+
});
15+
console.log(`hereNow response: ${response}`);
1616
} catch (status) {
17-
console.log(`hereNow failed with error: ${status}`);
17+
console.log(`hereNow failed with error: ${status}`);
1818
}
1919
// snippet.end
2020

2121
// snippet.hereNowFetchOccupancyOnly
2222
try {
23-
const response = await pubnub.hereNow({
24-
channels: ['my_channel'],
25-
includeUUIDs: false,
26-
});
27-
console.log(`hereNow response: ${response}`);
23+
const response = await pubnub.hereNow({
24+
channels: ['my_channel'],
25+
includeUUIDs: false,
26+
});
27+
console.log(`hereNow response: ${response}`);
2828
} catch (status) {
29-
console.log(`hereNow failed with error: ${status}`);
29+
console.log(`hereNow failed with error: ${status}`);
3030
}
3131
// snippet.end
3232

33-
3433
// snippet.hereNowChannelGroup
3534
try {
36-
const response = await pubnub.hereNow({
37-
channelGroups: ['my_channel_group'],
38-
});
39-
console.log(`hereNow response: ${response}`);
35+
const response = await pubnub.hereNow({
36+
channelGroups: ['my_channel_group'],
37+
});
38+
console.log(`hereNow response: ${response}`);
4039
} catch (status) {
41-
console.log(`hereNow failed with error: ${status}`);
40+
console.log(`hereNow failed with error: ${status}`);
4241
}
43-
// snippet.end
42+
// snippet.end

‎docs-snippets/publish-subscribe.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,4 +257,4 @@ pubnub.unsubscribe({
257257
// remove a subscription set from another subscription set
258258
subscriptionSet1.removeSubscriptionSet(subscriptionSet2);
259259
// snippet.end
260-
}
260+
}

0 commit comments

Comments
 (0)