# synchd

> Make guarded sections of code that won't run concurrently and queue instead

Latest version **1.1.0** (published 2018-09-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install synchd
pnpm add synchd
yarn add synchd
bun add synchd
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2018-09-26 |
| First published | 2016-09-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 10.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Chris Cowan |
| Maintainers | agentme |
| Keywords | mutex, asynchronous, queue, promise |

## Links

- npm: https://www.npmjs.com/package/synchd
- Repository: https://github.com/Macil/synchd
- Homepage: https://github.com/Macil/synchd#readme
- Issues: https://github.com/Macil/synchd/issues
- npm.io page: https://npm.io/package/synchd

## Dependencies (1)

- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.0.0

## Alternatives

- [promise-throttle](https://npm.io/package/promise-throttle.md) — 44.2K weekly downloads
- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2018-09-26
- 1.0.2 — 2016-09-16
- 1.0.1 — 2016-09-16
- 1.0.0 — 2016-09-16
- 0.1.0 — 2016-09-16

## README

# synchd

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Macil/synchd/blob/master/LICENSE.txt) [![npm version](https://img.shields.io/npm/v/synchd.svg?style=flat)](https://www.npmjs.com/package/synchd) [![CircleCI Status](https://circleci.com/gh/Macil/synchd.svg?style=shield)](https://circleci.com/gh/Macil/synchd) [![Greenkeeper badge](https://badges.greenkeeper.io/Macil/synchd.svg)](https://greenkeeper.io/)

This module allows guarded sections of code to be made that execute exclusively
in the order they're called.

Similar to [node-synchronized](https://github.com/jupiter/node-synchronized),
but uses Promises and includes Flow type declarations.

## API

This project exports the `synchd` and `synchdFn` functions. If you're using an
ES6 compiler, you can access them like this:

```js
import {synchd, synchdFn} from 'synchd';
```

Or you can access the functions through the classic CommonJS style:

```js
var synchd = require('synchd');
// synchd.synchd(...)
// synchd.synchdFn(...)
```

### synchd(scopeKey, fn)

`scopeKey` may be any object and it's used as the lock. No other synchd calls
with the same scopeKey given will be run at the same time; they will be queued
in-order to run after. `fn` is a function which takes no arguments and must
return a Promise.

This call returns a Promise that resolves to the same value that the Promise
returned by `fn` resolves to.

### synchdFn(scopeKey, fn)

This is a convenience function for creating functions that are entirely wrapped
in a synchd call with a single scopeKey.

`scopeKey` has the same meaning as above. `fn` is a function that may take
arguments and must return a Promise.

This call returns a function with the same signature as `fn`. All arguments
passed to the function will be passed on to `fn` when it gets executed, and the
returned Promise will resolve to the value of the Promise that `fn` returns.

Here's an example of defining a single function which can't be running multiple
times concurrently. This example assumes you're using a compiler which supports
async/await.

```js
import {synchdFn} from 'synchd';
import delay from 'pdelay';

const exclusiveFunction = synchdFn({}, async (x) => {
  console.log(`exclusiveFunction(${x}) started`);
  await delay(100);
  console.log(`exclusiveFunction(${x}) ending`);
  return x+1;
});

exclusiveFunction(5);
exclusiveFunction(6);

// The following will be printed:
// exclusiveFunction(5) started
// exclusiveFunction(5) ending
// exclusiveFunction(6) started
// exclusiveFunction(6) ending
```

## Types

Both [TypeScript](https://www.typescriptlang.org/) and
[Flow](https://flowtype.org/) type definitions for this module are included!
The type definitions won't require any configuration to use.

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