From 7c9f3c68b106804a81b0c7c95f104dbbca5d5fdd Mon Sep 17 00:00:00 2001 From: aashikam Date: Wed, 21 Jun 2023 08:54:55 +0530 Subject: [PATCH] Add suggestions from code review --- examples/nats-jetstream-pub/nats_jetstream_pub.bal | 4 ++-- examples/nats-jetstream-pub/nats_jetstream_pub.md | 2 +- examples/nats-jetstream-sub/nats_jestream_sub.bal | 4 ++-- examples/nats-jetstream-sub/nats_jestream_sub.md | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/nats-jetstream-pub/nats_jetstream_pub.bal b/examples/nats-jetstream-pub/nats_jetstream_pub.bal index d64fd67298..db4235b772 100644 --- a/examples/nats-jetstream-pub/nats_jetstream_pub.bal +++ b/examples/nats-jetstream-pub/nats_jetstream_pub.bal @@ -16,7 +16,7 @@ service / on new http:Listener(9092) { // Initiate a NATS client passing the URL of the NATS broker. nats:Client natsClient = check new (nats:DEFAULT_URL); - // Initiate the NATS JetStreamClient at the start of the service. This will be used + // Initiate the NATS `JetStreamClient` at the start of the service. This will be used // throughout the lifetime of the service. self.orderClient = check new (natsClient); nats:StreamConfiguration config = { @@ -28,7 +28,7 @@ service / on new http:Listener(9092) { } resource function post orders(Order newOrder) returns http:Accepted|error { - // Produces a message to the specified subject. + // Produce a message to the specified subject. check self.orderClient->publishMessage({ subject: self.SUBJECT_NAME, content: newOrder.toString().toBytes() diff --git a/examples/nats-jetstream-pub/nats_jetstream_pub.md b/examples/nats-jetstream-pub/nats_jetstream_pub.md index c93868b8b2..1af04eea49 100644 --- a/examples/nats-jetstream-pub/nats_jetstream_pub.md +++ b/examples/nats-jetstream-pub/nats_jetstream_pub.md @@ -1,6 +1,6 @@ # NATS JetStream client - Publish message -The `nats:JetStreamClient` allows you to publish messages to a specific subject. To create a `nats:JetStreamClient`, you need to provide a valid instance of the `nats:Client`. Before publishing messages, you should call the addStream function to configure the stream. This function requires a `nats:JetStreamConfiguration` object with the values `name`, `subjects`, and `storageType`. To publish messages, you can use the `publishMessage` method, which takes the message content and subject as arguments. This method allows you to send messages that can be received by one or more subscribers. +The `nats:JetStreamClient` allows you to publish messages to a specific subject. To create a `nats:JetStreamClient`, you need to provide a valid instance of the `nats:Client`. Before publishing messages, you should call the `addStream` function to configure the stream. This function requires a `nats:JetStreamConfiguration` object with the `name`, `subjects`, and `storageType` values. To publish messages, you can use the `publishMessage` method, which takes the message content and subject as arguments. This method allows you to send messages that can be received by one or more subscribers. ::: code nats_jetstream_pub.bal ::: diff --git a/examples/nats-jetstream-sub/nats_jestream_sub.bal b/examples/nats-jetstream-sub/nats_jestream_sub.bal index 146a800d14..13c26f7d20 100644 --- a/examples/nats-jetstream-sub/nats_jestream_sub.bal +++ b/examples/nats-jetstream-sub/nats_jestream_sub.bal @@ -11,7 +11,7 @@ type Order readonly & record { // Initiate a NATS client passing the URL of the NATS broker. nats:Client natsClient = check new (nats:DEFAULT_URL); -// Initializes a NATS JetStream listener. +// Initialize a NATS JetStream listener. listener nats:JetStreamListener subscription = new (natsClient); const string SUBJECT_NAME = "orders"; @@ -19,7 +19,7 @@ const string SUBJECT_NAME = "orders"; subject: SUBJECT_NAME, autoAck: false } -// Binds the consumer to listen to the messages published to the 'orders' subject. +// Bind the consumer to listen to the messages published to the 'orders' subject. service nats:JetStreamService on subscription { remote function onMessage(nats:JetStreamMessage message) returns error? { string stringContent = check string:fromBytes(message.content); diff --git a/examples/nats-jetstream-sub/nats_jestream_sub.md b/examples/nats-jetstream-sub/nats_jestream_sub.md index 5b1a657168..678a23ce79 100644 --- a/examples/nats-jetstream-sub/nats_jestream_sub.md +++ b/examples/nats-jetstream-sub/nats_jestream_sub.md @@ -1,6 +1,6 @@ # NATS JetStream service - Consume message -The `nats:JetStreamService` listens to a specified subject for incoming messages. Whenever a publisher sends a message to that subject, any active service listening to it will receive the message. To create a `nats:JetStreamListener`, you need to provide an instance of the `nats:Client`. Once you have a `nats:JetStreamListener`, you can attach a `nats:JetStreamService` to it in order to listen to a specific subject and consume incoming messages. The subject to listen to can be either specified as the service path or provided in the `subject` field of the `nats:StreamServiceConfig`. This setup allows you to effectively listen to messages sent to a particular subject. +The `nats:JetStreamService` listens to a specified subject for incoming messages. Whenever a publisher sends a message to that subject, any active service listening to it will receive the message. You need to provide an instance of the `nats:Client` to create a `nats:JetStreamListener`. Once you have a `nats:JetStreamListener`, you can attach a `nats:JetStreamService` to it in order to listen to a specific subject and consume incoming messages. The subject to listen to can be either specified as the service path or provided in the `subject` field of the `nats:StreamServiceConfig`. This setup allows you to effectively listen to messages sent to a particular subject. ::: code nats_jestream_sub.bal :::