Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/microsoft/etcd3
:bookmark: Node.js client for etcd3
https://github.com/microsoft/etcd3
client-library etcd etcdv3 grpc javascript js node nodejs
Last synced: 6 days ago
JSON representation
:bookmark: Node.js client for etcd3
- Host: GitHub
- URL: https://github.com/microsoft/etcd3
- Owner: microsoft
- License: other
- Created: 2017-04-08T22:11:31.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-11T03:21:11.000Z (8 months ago)
- Last Synced: 2025-01-17T08:05:43.219Z (13 days ago)
- Topics: client-library, etcd, etcdv3, grpc, javascript, js, node, nodejs
- Language: TypeScript
- Homepage: https://microsoft.github.io/etcd3/classes/etcd3.html
- Size: 2.52 MB
- Stars: 522
- Watchers: 11
- Forks: 73
- Open Issues: 24
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# etcd3 [](https://github.com/microsoft/etcd3/actions?query=workflow%3A%22Run+Tests%22)
etcd3 is a high-quality, production-ready client for the Protocol Buffer-based [etcd](https://etcd.io/) v3 API. It includes:
- [load balancing](https://microsoft.github.io/etcd3/interfaces/ioptions.html)
- [fault handling and reconnections](https://microsoft.github.io/etcd3/interfaces/ioptions.html#faulthandling)
- [transactions](https://microsoft.github.io/etcd3/classes/comparatorbuilder.html)
- [software transactional memory](https://microsoft.github.io/etcd3/classes/softwaretransaction.html)
- [high-level query builders](https://microsoft.github.io/etcd3/classes/etcd3.html)
- [lease management](https://microsoft.github.io/etcd3/classes/lease.html)
- [watchers](https://microsoft.github.io/etcd3/classes/watchbuilder.html)
- [user](https://microsoft.github.io/etcd3/classes/etcd3.html#user) and [role](https://microsoft.github.io/etcd3/classes/etcd3.html#role) [mocking](https://microsoft.github.io/etcd3/classes/etcd3.html#mock) management
- [elections](https://microsoft.github.io/etcd3/classes/election.html)
and is type-safe for TypeScript consumers.
### Quickstart
Install via:
```
npm install --save etcd3
```
Start building!
```js
const { Etcd3 } = require('etcd3');
const client = new Etcd3();
(async () => {
await client.put('foo').value('bar');
const fooValue = await client.get('foo').string();
console.log('foo was:', fooValue);
const allFValues = await client.getAll().prefix('f').keys();
console.log('all our keys starting with "f":', allFValues);
await client.delete().all();
})();
```
### API Documentation
Our [TypeDoc docs are available here](https://microsoft.github.io/etcd3/classes/etcd3.html).
Our [test cases](https://github.com/microsoft/etcd3/tree/master/src/test/) are also readable.
### Running tests
```sh
$ npm install
$ cd src/test/containers/3.2 && docker-compose up # in a separate shell
$ npm test
$ docker-compose down
```
### Contributing
Running tests for this module requires running an etcd3 server locally. The tests try to use the default port initially, and you can configure this by setting the `ETCD_ADDR` environment variable, like `export ETCD_ADDR=localhost:12345`.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.