@azure/eventhubs-checkpointstore-table 1.0.0-alpha.20220520.1 → 1.0.0-alpha.20220919.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -9
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -3,15 +3,15 @@
|
|
|
3
3
|
An Azure Table storage based solution to store checkpoints and to aid in load balancing when using `EventHubConsumerClient` from the [@azure/event-hubs](https://www.npmjs.com/package/@azure/event-hubs) library
|
|
4
4
|
|
|
5
5
|
Key Links:
|
|
6
|
-
- [Source code](#)
|
|
7
|
-
- [Package (npm)](https://www.npmjs.com/package/@azure/eventhubs-checkpointstore-table)
|
|
8
|
-
- [API Reference Documentation](#)
|
|
6
|
+
- [Source code](#)
|
|
7
|
+
- [Package (npm)](https://www.npmjs.com/package/@azure/eventhubs-checkpointstore-table)
|
|
8
|
+
- [API Reference Documentation](#)
|
|
9
9
|
- [Samples](#)
|
|
10
10
|
|
|
11
11
|
## Getting started
|
|
12
12
|
|
|
13
13
|
### Currently supported environments
|
|
14
|
-
- [LTS versions of Node.js](https://
|
|
14
|
+
- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
|
|
15
15
|
- Latest versions of Safari, Chrome, Edge, and Firefox.
|
|
16
16
|
|
|
17
17
|
See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
|
|
@@ -19,7 +19,7 @@ See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUP
|
|
|
19
19
|
|
|
20
20
|
### Prerequisites
|
|
21
21
|
- An [Azure subscription](https://azure.microsoft.com/free/)
|
|
22
|
-
- An [Event Hubs Namespace](https://docs.microsoft.com/azure/event-hubs/) to use this package
|
|
22
|
+
- An [Event Hubs Namespace](https://docs.microsoft.com/azure/event-hubs/) to use this package
|
|
23
23
|
- A [Storage account](https://docs.microsoft.com/azure/storage/tables/table-storage-overview)
|
|
24
24
|
|
|
25
25
|
### Install the package
|
|
@@ -56,7 +56,7 @@ You also need to enable `compilerOptions.allowSyntheticDefaultImports` in your t
|
|
|
56
56
|
and to provide resiliency if a failover between readers running on different machines occurs. It is possible to return to older data by specifying a lower offset from this checkpointing process.
|
|
57
57
|
Through this mechanism, checkpointing enables both failover resiliency and event stream replay.
|
|
58
58
|
|
|
59
|
-
|
|
59
|
+
|
|
60
60
|
|
|
61
61
|
A [TableCheckpointStore](#)
|
|
62
62
|
is a class that implements key methods required by the EventHubConsumerClient to balance load and update checkpoints.
|
|
@@ -72,8 +72,8 @@ You also need to enable `compilerOptions.allowSyntheticDefaultImports` in your t
|
|
|
72
72
|
Use the below code snippet to create a `CheckpointStore`. You will need to provide the connection string to your storage account.
|
|
73
73
|
|
|
74
74
|
```javascript
|
|
75
|
-
|
|
76
|
-
|
|
75
|
+
const { TableClient } = require("@azure/data-tables");
|
|
76
|
+
const { TableCheckpointStore } = require("@azure/eventhubs-checkpointstore-table");
|
|
77
77
|
|
|
78
78
|
const tableClient = new TableClient("storage-connection-string", "table-name");
|
|
79
79
|
|
|
@@ -220,4 +220,3 @@ directory for detailed example.
|
|
|
220
220
|
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.
|
|
221
221
|
|
|
222
222
|
|
|
223
|
-
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@azure/eventhubs-checkpointstore-table",
|
|
3
3
|
"sdk-type": "client",
|
|
4
|
-
"version": "1.0.0-alpha.
|
|
4
|
+
"version": "1.0.0-alpha.20220919.2",
|
|
5
5
|
"description": "An Azure Storage Table solution to store checkpoints when using Event Hubs.",
|
|
6
6
|
"author": "Microsoft Corporation",
|
|
7
7
|
"license": "MIT",
|
|
@@ -47,8 +47,8 @@
|
|
|
47
47
|
"integration-test:browser": "echo skipped",
|
|
48
48
|
"integration-test:node": "nyc mocha -r esm --require ts-node/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 1200000 --full-trace \"dist-esm/test/*.spec.js\"",
|
|
49
49
|
"integration-test": "npm run integration-test:node && npm run integration-test:browser",
|
|
50
|
-
"lint:fix": "eslint package.json api-extractor.json src test --ext .ts --fix",
|
|
51
|
-
"lint": "eslint package.json api-extractor.json src test --ext .ts",
|
|
50
|
+
"lint:fix": "eslint package.json api-extractor.json README.md src test --ext .ts,.javascript,.js --fix",
|
|
51
|
+
"lint": "eslint package.json api-extractor.json README.md src test --ext .ts,.javascript,.js",
|
|
52
52
|
"pack": "npm pack 2>&1",
|
|
53
53
|
"test:browser": "npm run build:test && npm run unit-test:browser && npm run integration-test:browser",
|
|
54
54
|
"test:node": "npm run integration-test:node",
|