docs: snippet for pubnub apis. by mohitpubnub · Pull Request #458 · pubnub/javascript

mohitpubnub · 2025-06-10T12:57:25Z

refactor: removed deprecation warning from deleteMessages method.

Removed deprecation warning from deleteMessages method.

docs: code snippets for using pubnub apis.

Added code snippets for docs.

…pp-context, mobile-push, access-manager, channel-groups.

pubnub-ops-terraform · 2025-06-10T12:57:45Z

🎉 Snyk checks have passed. No issues have been found so far.

✅ security/snyk check is complete. No issues have been found. (View Details)

✅ license/snyk check is complete. No issues have been found. (View Details)

…lisation.

…before snippet compilation happens

…od on subscriptionSet entity

parfeon

In each file (and sometimes even within the same file) there is a different indention level (or different tab width). Our codebase uses 2 spaces for tab.

I'm leaving early review comments because new files appeared while I was making this one and probably have similar issues + my browser lags with this much change suggestions.

parfeon · 2025-06-23T06:52:44Z

src/core/pubnub-common.ts

   */
-  public grantToken(parameters: PAM.GrantTokenParameters, callback: ResultCallback<PAM.GrantTokenResponse>): void;
+  public grantToken(
+    parameters: PAM.GrantTokenParameters | PAM.ObjectsGrantTokenParameters,


Is there a reason to have ObjectsGrantTokenParameters? Probably it has been added because I forgot to mark it as deprecated since it uses spaces and users while the new interface uses uuids and confusingly channels (which both regular and App Context metadata).

parfeon · 2025-06-23T07:05:03Z

docs-snippets/tsconfig.json

+    "compilerOptions": {
+      "module": "esnext",
+      "target": "es2017",
+      "outDir": "./docs",


We need to be careful here because during the release process run all changes added to the git. Should we add the docs folder to the .gitignore?

since
"noEmit": true,

It won't generate any js files on tsc.

parfeon · 2025-06-23T07:15:45Z

docs-snippets/access-manager.ts

+} catch (status) {
+    console.log(status);
+}


We receive error in catch blocks, not status. Though this one is PubNubError which has a status field with State object in it with additional details, so maybe something like this:

Suggested change

} catch (status) {

console.log(status);

}

} catch (error) {

console.error(`Grant token error: ${error}.${

error.status ? ` Additional information: ${error.status}` : '' }`);

}

all error handling updated as per suggestion.

parfeon · 2025-06-23T07:16:17Z

docs-snippets/access-manager.ts

+} catch (status) {
+    console.log(status);
+}


We receive error in catch blocks, not status. Though this one is PubNubError which has a status field with State object in it with additional details, so maybe something like this:

Suggested change

} catch (status) {

console.log(status);

}

} catch (error) {

console.error(`Grant token error: ${error}.${

error.status ? ` Additional information: ${error.status}` : '' }`);

}

parfeon · 2025-06-23T07:17:44Z

docs-snippets/access-manager.ts

+} catch (status) {
+    console.log(status);
+}


We receive error in catch blocks, not status. Though this one is PubNubError which has a status field with State object in it with additional details, so maybe something like this:

Suggested change

} catch (status) {

console.log(status);

}

} catch (error) {

console.error(`Grant token error: ${error}.${

error.status ? ` Additional information: ${error.status}` : '' }`);

}

parfeon · 2025-06-24T05:45:07Z

docs-snippets/publish-subscribe.ts

+  } catch (status) {
+    console.log(`publishing failed with status: ${status}`);
+  }


We receive error in catch blocks, not status. Though this one is PubNubError which has a status field with State object in it with additional details, so maybe something like this:

Suggested change

} catch (status) {

console.log(`publishing failed with status: ${status}`);

}

} catch (error) {

console.error(`Message publish error: ${error}.${

error.status ? ` Additional information: ${error.status}` : '' }`);

}

parfeon · 2025-06-24T05:47:43Z

docs-snippets/app-context.ts

+    } catch (error) {
+        console.error(error);
+    }


PubNubError has a status field with State object in it with additional details, so maybe something like this:

Suggested change

} catch (error) {

console.error(error);

}

} catch (error) {

console.error(`Set channel metadata error: ${error}.${

error.status ? ` Additional information: ${error.status}` : '' }`);

}

parfeon · 2025-06-24T05:49:16Z

docs-snippets/basic-usage/app-context.ts

+// Using UUID from the config  - default when uuid is not passed in the method
+try {
+    const response = await pubnub.objects.getUUIDMetadata();
+    console.log(`getUUIDMetadata response: ${response}`);


This will give output like this:

getUUIDMetadata response: [object Object]

not really informative.
But it could be better this way:

Suggested change

console.log(`getUUIDMetadata response: ${response}`);

console.log('getUUIDMetadata response:', response);

parfeon · 2025-06-24T05:52:09Z

docs-snippets/basic-usage/app-context.ts

+    const response = await pubnub.objects.getAllChannelMetadata({
+        filter: 'name LIKE "*Team"',
+    });
+    console.log(`getAllChannelMetadata response: ${response}`);


This will give output like this:

getAllChannelMetadata response: [object Object]

not really informative.
But it could be better this way:

Suggested change

console.log(`getAllChannelMetadata response: ${response}`);

console.log('getAllChannelMetadata response:', response);

All response output updated.

parfeon · 2025-06-24T05:53:28Z

docs-snippets/basic-usage/app-context.ts

+    const response = await pubnub.objects.setMemberships({
+        uuid: "my-uuid",
+        channels: [
+                    "my-channel",


Did the formatter really align this line that far and not four spaces from the channels work start on the previous line?

Applied formatting to all files.

Not sure why, I see sometimes git doesn't show the same indentation as I see in my IDE!!!

configuration is 2 spaces Tab.

…tax support, Error handling refactor in code snippets

* Indentation as per other code base

parfeon · 2025-06-26T11:43:57Z

docs-snippets/basic-usage/miscellaneous.ts

+const decrypted = pubnub.decrypt(encrypted); // Pass the encrypted data as the first parameter in decrypt Method
+// snippet.end
+
+// snippet.decryptFileBasicUsage


Suggested change

// snippet.decryptFileBasicUsage

// snippet.decryptFileBasicUsage

// Node.js example

// import fs from 'fs';

parfeon · 2025-06-26T11:44:24Z

docs-snippets/basic-usage/miscellaneous.ts

+// snippet.end
+
+// snippet.setProxyBasicUsage
+pubnub.setProxy({


Should we mention here that this is only Node.js stuff?

Mentioned in docs already here.

Still no harm adding into example again.

added comment.

parfeon · 2025-06-26T11:45:21Z

docs-snippets/basic-usage/mobile-push.ts

+
+// snippet.addDeciveToChannelBasicUsage
+// Function to add a device to a channel for APNs2
+async function addDeviceToChannelAPNs2() {


I thought we don't need functions (there were few before this file as well).

parfeon · 2025-06-26T11:46:59Z

docs-snippets/basic-usage/mobile-push.ts

+    console.log('Operation done for APNs2!');
+    console.log('Response:', result);
+  } catch (error) {
+    console.log('Operation failed with error for APNs2:', error);


Do you want to have similar output as in snippets above?

In previous review summary, I've left, that because new files appeared I've stopped. Same issues as I marked in previous files were in the rest (status in catch block instead of error and more detailed output).

scanning files which did not have comments earlier ⏳

parfeon · 2025-06-26T11:49:02Z

docs-snippets/basic-usage/presence.ts

+    console.log(response);
+  })
+  .catch((error) => {
+    console.log(error);


Do we want more detailed output here like this:

Suggested change

console.log(error);

console.error(

`State set failed: ${error}.${

(error as PubNubError).status ? ` Additional information: ${(error as PubNubError).status}` : ''

}`,

);

updated in presence.ts

parfeon · 2025-06-26T11:57:48Z

docs-snippets/publish-subscribe.ts

+  );
+}
+// snippet.end
+// *********** Compilation Error due to wrong code *****************


Do we need this one in final document?

parfeon · 2025-06-26T11:59:56Z

docs-snippets/presence.ts

+  console.log(`hereNow response: ${response}`);
+} catch (status) {
+  console.log(`hereNow failed with error: ${status}`);


Same issues in this file as in previous with how object will be printed in formatted string and status instead of error.

covered in presence.ts file

parfeon · 2025-06-26T12:01:33Z

docs-snippets/message-persistence.ts

+  console.log(`fetch messages response: ${response}`);
+} catch (status) {
+  console.log(`fetch messages failed with error: ${status}`);


Same issues in this file as in previous with how object will be printed in formatted string and status instead of error.

message-persistence.ts updated

parfeon · 2025-06-26T12:02:15Z

docs-snippets/getting-started.ts

+    console.log(`Message published with timetoken: ${result.timetoken}`);
+    console.log(`You: ${text}`);
+  } catch (error) {
+    console.error(`Publish failed: ${error}`);


More detailed output with status?

parfeon · 2025-06-26T12:03:06Z

docs-snippets/getting-started.ts

+    if (event.category === 'PNConnectedCategory') {
+      console.log('Connected to PubNub chat!');
+    } else if (event.category === 'PNNetworkIssuesCategory') {
+      console.log('Connection lost. Attempting to reconnect...');


This one depending on from settings.

description updated

parfeon

Small note, but in general looks good! :)

parfeon · 2025-06-27T16:46:55Z

docs-snippets/getting-started-example.ts

+    console.log(`\nMessage sent successfully!`);
+  } catch (error) {
+    // Handle publish errors
+    console.error(`\n❌ Failed to send message: ${error}`);


Can add more info :)

mohitpubnub · 2025-06-30T05:52:36Z

@pubnub-release-bot release

pubnub-release-bot · 2025-06-30T06:10:49Z

🚀 Release successfully completed 🚀

Mohit Tejani added 2 commits June 10, 2025 17:21

docs snippets for publish-subscribe, presence, message-persistence, a…

f7522bf

…pp-context, mobile-push, access-manager, channel-groups.

fix: lint issue.

b88f985

mohitpubnub self-assigned this Jun 10, 2025

mohitpubnub added the status: in progress This issue is being worked on. label Jun 10, 2025

Mohit Tejani added 2 commits June 15, 2025 22:38

removed deprecation from deleteMessages()

64ba5f0

code snippets for documentation. A separate file for impot and initia…

42ba1de

…lisation.

mohitpubnub marked this pull request as ready for review June 15, 2025 17:12

mohitpubnub requested review from parfeon and seba-aln as code owners June 15, 2025 17:12

mohitpubnub requested a review from techwritermat June 15, 2025 17:13

mohitpubnub removed the status: in progress This issue is being worked on. label Jun 16, 2025

Mohit Tejani added 9 commits June 16, 2025 14:56

configuration code snippets

92af28f

script to compile check the code snippets

3146b47

fix: snippet compilation for lowest node version and build generated …

c29a021

…before snippet compilation happens

added missing iterativelyUpdateExistingMetadata

83fc584

example with promises syntax demo

d2c73db

missing SubscriptionSet subscribe() basic usage example

e23870d

added missing subscriptionSet example code snippets

3f03362

added getFilterExpresssionBasicusage

1e3d2fb

revert changes of providing return type for addSubscriptionSet() meth…

d7a28c7

…od on subscriptionSet entity

mohitpubnub added the status: in progress This issue is being worked on. label Jun 23, 2025

Mohit Tejani and others added 3 commits June 23, 2025 17:44

added getting started code snippets

7e9e949

added missing generic listener syntax example

5f1cfb3

Merge branch 'master' into docs-snippets

ffe1a88

parfeon requested changes Jun 24, 2025

View reviewed changes

Mohit Tejani added 4 commits June 24, 2025 18:21

fix snippets indentation, GrantToken type fix by removing objects syn…

f97d77f

…tax support, Error handling refactor in code snippets

additional information about send file code snippet in node.js

27519f1

* address Codacy quality checks suggestions.

aab00bd

* Indentation as per other code base

Codacy suggestions

133b270

lint: codacy suggestion

772d575

mohitpubnub requested a review from parfeon June 25, 2025 13:12

Mohit Tejani added 2 commits June 25, 2025 19:08

removed deprected warning from deleteMessages API

3907c2d

added snippet for connect, disconnect and delete proxy

8914345

mohitpubnub added status: done This issue is considered resolved. and removed status: in progress This issue is being worked on. labels Jun 26, 2025

code snippets: formating setToken strings

a491042

parfeon requested changes Jun 26, 2025

View reviewed changes

Mohit Tejani added 2 commits June 26, 2025 17:46

fix dummy token length related format issue.

9be3a02

code snippet: error handling, additional comments

cdfe082

mohitpubnub removed the status: done This issue is considered resolved. label Jun 26, 2025

mohitpubnub requested a review from parfeon June 27, 2025 05:57

mohitpubnub added the status: done This issue is considered resolved. label Jun 27, 2025

parfeon approved these changes Jun 27, 2025

View reviewed changes

details about exception in getting started example.

475b1dd

PubNub SDK v9.6.2 release.

8ac814d

pubnub-release-bot requested a review from kazydek as a code owner June 30, 2025 05:54

mohitpubnub merged commit 8bf31a4 into master Jun 30, 2025
11 of 13 checks passed

mohitpubnub deleted the docs-snippets branch June 30, 2025 06:06

	console.log(`getUUIDMetadata response: ${response}`);
	console.log('getUUIDMetadata response:', response);

	console.log(`getAllChannelMetadata response: ${response}`);
	console.log('getAllChannelMetadata response:', response);

Conversation

mohitpubnub commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pubnub-ops-terraform commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎉 Snyk checks have passed. No issues have been found so far.

Uh oh!

parfeon left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mohitpubnub Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

mohitpubnub commented Jun 10, 2025 •

edited

Loading

pubnub-ops-terraform commented Jun 10, 2025 •

edited

Loading

mohitpubnub Jun 25, 2025 •

edited

Loading