# create-async-flag

> Simple promise utility for separate, but dependent control flow.

Latest version **0.1.1** (published 2018-07-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install create-async-flag
pnpm add create-async-flag
yarn add create-async-flag
bun add create-async-flag
```

## 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.1 |
| Published | 2018-07-30 |
| First published | 2018-07-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | nickbreaton |
| Maintainers | nickbreaton |

## Links

- npm: https://www.npmjs.com/package/create-async-flag
- Repository: https://github.com/nickbreaton/create-async-flag
- npm.io page: https://npm.io/package/create-async-flag

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) ^10.5.2

## Recent versions

- 0.1.1 (latest) — 2018-07-30
- 0.1.0 — 2018-07-30
- 0.0.3 — 2018-07-19
- 0.0.2 — 2018-07-14
- 0.0.1 — 2018-07-14

## README

# create-async-flag

Simple promise utility for separate, but dependent control flow. [See example here.](https://stackblitz.com/edit/create-async-flag)

## API

#### `createAsyncFlag()`

> Creates a flag that can be `set`, `unset`, and `wait` upon.
> ```js
> import createAsyncFlag from 'create-async-flag';
>
> const flag = createAsyncFlag();
> ```
<br>

#### `[flag].wait()`

> Creates a promise that will only resolve once `set`, or resolve immediatly if already `set`.
> ```js
> const flag = createAsyncFlag();
>
> async function run() {
>   // ...
>   await flag.wait(); // execution will hault until flag is `set`
>   // ...
> }
> ```
<br>

#### `[flag].set()`

> Marks the flag to be immediatly resolved, and to resolve any currently waiting promises.
> ```js
> const flag = createAsyncFlag();
>
> function log() {
>   flag.wait().then(() => console.log('one'));
>   flag.set();
>   flag.wait().then(() => console.log('two'));
> }
>
> log(); // => 'one'
>        // => 'two'
<br>

#### `[flag].unset()`

> Marks a flag to wait until set is called again.
> ```js
> const flag = createAsyncFlag();
>
> async function start() {
>   flag.unset();
>   await flag.wait();
>   return; // will never return, unless `set` is called
> }

#### `[flag].isSet()`

> Returns the current state of the flag.
> ```js
> const flag = createAsyncFlag();
>
> flag.isSet(); // => false
> flag.set();
> flag.isSet(); // => true

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