# ordered-lock

> Minimalist single thread ordered lock for distributed clients.

Latest version **0.1.6** (published 2020-11-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install ordered-lock
pnpm add ordered-lock
yarn add ordered-lock
bun add ordered-lock
```

Provides the command `ordered-lock-server`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.6 |
| Published | 2020-11-17 |
| First published | 2020-07-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 53.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Chengdu Mufan Technology Co., Ltd. |
| Maintainers | vilic |

## Links

- npm: https://www.npmjs.com/package/ordered-lock
- Repository: https://github.com/makeflow/ordered-lock
- Homepage: https://github.com/makeflow/ordered-lock#readme
- Issues: https://github.com/makeflow/ordered-lock/issues
- npm.io page: https://npm.io/package/ordered-lock

## Dependencies (4)

- [uuid](https://npm.io/package/uuid.md) ^8.2.0
- [debug](https://npm.io/package/debug.md) ^4.1.1
- [villa](https://npm.io/package/villa.md) ^0.3.2
- [socket-jet](https://npm.io/package/socket-jet.md) ^0.2.5

## Recent versions

- 0.1.6 (latest) — 2020-11-17
- 0.1.5 — 2020-08-08
- 0.1.4 — 2020-08-08
- 0.1.3 — 2020-07-09
- 0.1.2 — 2020-07-09

## README

[![NPM Package](https://badge.fury.io/js/ordered-lock.svg)](https://www.npmjs.com/package/ordered-lock)
[![Build Status](https://travis-ci.org/makeflow/ordered-lock.svg?branch=master)](https://travis-ci.org/makeflow/ordered-lock)

# Ordered Lock

Minimalist single thread ordered lock for distributed clients.

## Installation

### All-in-One

```
yarn add ordered-lock
```

```ts
import {Client} from 'ordered-lock';

let client = new Client({
  connect: {
    host: 'ordered-lock',
    port: 3292,
  },
  lock: {
    ttl: 2,
    lockingTimeout: 10,
  },
});

client.lock('123', async extend => {
  // ...

  extend(2);
});

client.lock(['123', '456'], async extend => {
  // ...
});
```

You probably don't need to use the server library, check out the Docker image.

```ts
import {Server} from 'ordered-lock/server';

// ...
```

### Docker

```
docker pull makeflow/ordered-lock
```

It listens on port `3292`.

## License

MIT License.

---
_Source: https://npm.io/package/ordered-lock · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._