# subatomic-elements

> A library for processing generator javascript functions with automatic retries on transitory failures.

Latest version **0.1.0** (published 2020-09-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install subatomic-elements
pnpm add subatomic-elements
yarn add subatomic-elements
bun add subatomic-elements
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2020-09-03 |
| First published | 2020-09-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Karl Hulme |
| Maintainers | lusypher |

## Links

- npm: https://www.npmjs.com/package/subatomic-elements
- Repository: https://github.com/karlhulme/piggle
- Homepage: https://github.com/karlhulme/piggle#readme
- Issues: https://github.com/karlhulme/piggle/issues
- npm.io page: https://npm.io/package/subatomic-elements

## Recent versions

- 0.1.0 (latest) — 2020-09-03
- 0.1.4 — 2020-09-03

## README

# Piggle

![](https://github.com/karlhulme/piggle/workflows/CD/badge.svg)
[![npm](https://img.shields.io/npm/v/piggle.svg)](https://www.npmjs.com/package/piggle)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

Define long-running tasks as javascript generator functions.  Ensure there's a yield after each important change.

Piggle will then execute those tasks ensuring that any transitory failures are retries automatically.

If the long-running task cannot be completed then it will output the current progress as an object.  You can store this object in a database, and you can pass this object back to Piggle to have it resume the task from wherever it left off.

There's a good piggle!

## installation

```bash
npm install piggle
```

## Development

Code base adheres to the rules chosen by https://standardjs.com/.  Code is formatted with 2 spaces.

Tests are written using Jest with 100% coverage.

```javascript
npm test
```

## Continuous Integration and Deployment

Any pushes or pull-requests on non-master branches will trigger the test runner.
Any pushes to master will cause the library to be re-published.

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