@azure/eventhubs-checkpointstore-blob 2.0.0-alpha.20250203.2 → 2.0.0-alpha.20250206.1

package/README.md

@@ -70,9 +70,9 @@ You also need to enable `compilerOptions.allowSyntheticDefaultImports` in your t
 
 Use the below code snippet to create a `CheckpointStore`. You will need to provide the connection string to your storage account.
 
-```javascript
-const { ContainerClient } = require("@azure/storage-blob");
-const { BlobCheckpointStore } = require("@azure/eventhubs-checkpointstore-blob");
+```ts snippet:ReadmeSampleCreateCheckpointStore
+import { ContainerClient } from "@azure/storage-blob";
+import { BlobCheckpointStore } from "@azure/eventhubs-checkpointstore-blob";
 
 const containerClient = new ContainerClient("storage-connection-string", "container-name");
 
@@ -91,10 +91,10 @@ interface along with code to call the `updateCheckpoint()` method.
 
 In this example, `SubscriptionHandlers` implements [SubscriptionEventHandlers](https://learn.microsoft.com/javascript/api/@azure/event-hubs/subscriptioneventhandlers) and also handles checkpointing.
 
-```javascript
-const { EventHubConsumerClient } = require("@azure/event-hubs");
-const { ContainerClient } = require("@azure/storage-blob");
-const { BlobCheckpointStore } = require("@azure/eventhubs-checkpointstore-blob");
+```ts snippet:ReadmeSampleCheckpointEvents
+import { ContainerClient } from "@azure/storage-blob";
+import { BlobCheckpointStore } from "@azure/eventhubs-checkpointstore-blob";
+import { EventHubConsumerClient } from "@azure/event-hubs";
 
 const storageAccountConnectionString = "storage-account-connection-string";
 const containerName = "container-name";
@@ -102,53 +102,48 @@ const eventHubConnectionString = "eventhub-connection-string";
 const consumerGroup = "my-consumer-group";
 const eventHubName = "eventHubName";
 
-async function main() {
-  const blobContainerClient = new ContainerClient(storageAccountConnectionString, containerName);
-
-  if (!(await blobContainerClient.exists())) {
-    await blobContainerClient.create();
-  }
-
-  const checkpointStore = new BlobCheckpointStore(blobContainerClient);
-  const consumerClient = new EventHubConsumerClient(
-    consumerGroup,
-    eventHubConnectionString,
-    eventHubName,
-    checkpointStore,
-  );
-
-  const subscription = consumerClient.subscribe({
-    processEvents: async (events, context) => {
-      // event processing code goes here
-      if (events.length === 0) {
-        // If the wait time expires (configured via options in maxWaitTimeInSeconds) Event Hubs
-        // will pass you an empty array.
-        return;
-      }
-
-      // Checkpointing will allow your service to pick up from
-      // where it left off when restarting.
-      //
-      // You'll want to balance how often you checkpoint with the
-      // performance of your underlying checkpoint store.
-      await context.updateCheckpoint(events[events.length - 1]);
-    },
-    processError: async (err, context) => {
-      // handle any errors that occur during the course of
-      // this subscription
-      console.log(`Errors in subscription to partition ${context.partitionId}: ${err}`);
-    },
-  });
-
-  // Wait for a few seconds to receive events before closing
-  await new Promise((resolve) => setTimeout(resolve, 10 * 1000));
-
-  await subscription.close();
-  await consumerClient.close();
-  console.log(`Exiting sample`);
+const blobContainerClient = new ContainerClient(storageAccountConnectionString, containerName);
+
+if (!(await blobContainerClient.exists())) {
+  await blobContainerClient.create();
 }
 
-main();
+const checkpointStore = new BlobCheckpointStore(blobContainerClient);
+const consumerClient = new EventHubConsumerClient(
+  consumerGroup,
+  eventHubConnectionString,
+  eventHubName,
+  checkpointStore,
+);
+
+const subscription = consumerClient.subscribe({
+  processEvents: async (events, context) => {
+    // event processing code goes here
+    if (events.length === 0) {
+      // If the wait time expires (configured via options in maxWaitTimeInSeconds) Event Hubs
+      // will pass you an empty array.
+      return;
+    }
+
+    // Checkpointing will allow your service to pick up from
+    // where it left off when restarting.
+    //
+    // You'll want to balance how often you checkpoint with the
+    // performance of your underlying checkpoint store.
+    await context.updateCheckpoint(events[events.length - 1]);
+  },
+  processError: async (err, context) => {
+    // handle any errors that occur during the course of
+    // this subscription
+    console.log(`Errors in subscription to partition ${context.partitionId}: ${err}`);
+  },
+});
+
+// Wait for a few seconds to receive events before closing
+await new Promise((resolve) => setTimeout(resolve, 10 * 1000));
+
+await subscription.close();
+await consumerClient.close();
 ```
 
 ## Troubleshooting
@@ -166,6 +161,12 @@ You can also set the log level programatically by importing the
 [@azure/logger](https://www.npmjs.com/package/@azure/logger) package and calling the
 `setLogLevel` function with one of the log level values.
 
+```ts snippet:SetLogLevel
+import { setLogLevel } from "@azure/logger";
+
+setLogLevel("info");
+```
+
 When setting a log level either programatically or via the `AZURE_LOG_LEVEL` environment variable,
 any logs that are written using a log level equal to or less than the one you choose will be emitted.
 For example, when you set the log level to `info`, the logs that are written for levels
@@ -214,5 +215,3 @@ directory for detailed example.
 ## Contributing
 
 If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
-
-![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Feventhub%2Feventhubs-checkpointstore-blob%2FREADME.png)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@azure/eventhubs-checkpointstore-blob",
   "sdk-type": "client",
-  "version": "2.0.0-alpha.20250203.2",
+  "version": "2.0.0-alpha.20250206.1",
   "description": "An Azure Storage Blob solution to store checkpoints when using Event Hubs.",
   "author": "Microsoft Corporation",
   "license": "MIT",
@@ -51,7 +51,7 @@
     "unit-test": "npm run unit-test:node && npm run unit-test:browser",
     "unit-test:browser": "echo skipped",
     "unit-test:node": "echo skipped",
-    "update-snippets": "echo skipped",
+    "update-snippets": "dev-tool run update-snippets",
     "vitest:node": "dev-tool run test:vitest --no-test-proxy"
   },
   "tshy": {
@@ -73,8 +73,8 @@
     "@azure/abort-controller": "^2.1.2",
     "@azure/core-paging": "^1.6.2",
     "@azure/event-hubs": ">=6.0.0-alpha <6.0.0-alphb",
-    "@azure/logger": "^1.1.3",
-    "@azure/storage-blob": "^12.24.0",
+    "@azure/logger": "^1.1.4",
+    "@azure/storage-blob": ">=12.26.0-alpha <12.26.0-alphb",
     "tslib": "^2.6.3"
   },
   "devDependencies": {
@@ -85,9 +85,9 @@
     "@azure/core-util": "^1.9.1",
     "@azure/dev-tool": ">=1.0.0-alpha <1.0.0-alphb",
     "@azure/eslint-plugin-azure-sdk": ">=3.0.0-alpha <3.0.0-alphb",
-    "@azure/identity": "^4.4.1",
+    "@azure/identity": "^4.6.0",
     "@rollup/plugin-inject": "^5.0.5",
-    "@types/chai-as-promised": "^7.1.8",
+    "@types/chai-as-promised": "^8.0.1",
     "@types/debug": "^4.1.12",
     "@types/node": "^18.0.0",
     "@vitest/browser": "^3.0.3",
@@ -101,7 +101,6 @@
     "playwright": "^1.45.3",
     "process": "^0.11.10",
     "stream": "^0.0.3",
-    "tsx": "^4.16.2",
     "typescript": "~5.7.2",
     "vitest": "^3.0.3"
   },