scottk/safe-redis-leader
1
0
Fork 0
mirror of https://github.com/lingble/safe-redis-leader.git synced 2025-10-29 11:42:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: README

Browse Source
This commit is contained in:
Marc G
2021-07-15 15:48:46 +00:00
parent 3148c9da39
commit d15fda615a
2 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -2,6 +2,11 @@
Fork of: [Safe Redis Leader](https://www.npmjs.com/package/safe-redis-leader) Fork of: [Safe Redis Leader](https://www.npmjs.com/package/safe-redis-leader)
1. Built with typescript
2. New tests running with Jest and testing multiple instances at the same time to make sure there is only 1 leader at all time
3. New event (main reason of this fork)
- After an election, all the instances will send an event either ```elected``` or ```notElected```
## Goal ## Goal
The Safe Redis Leader TS module is designed to provide a leader election implementation that provides tested gaurentees that there is only a single leader elected from a group of clients at one time. The Safe Redis Leader TS module is designed to provide a leader election implementation that provides tested gaurentees that there is only a single leader elected from a group of clients at one time.
@@ -10,9 +15,7 @@ The implementation is a port of the stale [Redis Leader npm package](https://git
1. Only exposes public api functions that should be exposed (no more public-but-should-be-private `_elect` fn) 1. Only exposes public api functions that should be exposed (no more public-but-should-be-private `_elect` fn)
2. has a test suite within docker-compose using a real redis instance, which allows anyone to run the tests with no heavy dependency setup 2. has a test suite within docker-compose using a real redis instance, which allows anyone to run the tests with no heavy dependency setup
3. Has tests to assert the known race condition can no longer occur 3. Replace callback-hell with async/await
4. Replace callback-hell with async/await
5. Built with typescript
## Usage ## Usage

2
package.json
View File

@@ -1,6 +1,6 @@
{ {
"name": "ts-safe-redis-leader", "name": "ts-safe-redis-leader",
"version": "0.0.1", "version": "0.0.2",
"description": "Redis leader election implementation that does not have any race conditions in Typescript", "description": "Redis leader election implementation that does not have any race conditions in Typescript",
"main": "src/index.js", "main": "src/index.js",
"scripts": { "scripts": {