# flipcache

> [temporary], safe, restorable, cacheable, configurable, chainable/fluent data

Latest version **0.0.12** (published 2017-04-16) · 0 weekly downloads

## Install

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

## 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.0.12 |
| Published | 2017-04-16 |
| First published | 2017-04-01 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 30 |
| Author | James |
| Maintainers | aretecode |
| Keywords | cli, temp, cache, fliphub, safe, temporary, restore, fs |

## Links

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

## Dependencies (9)

- [execa](https://npm.io/package/execa.md) 0.6.3
- [flipfile](https://npm.io/package/flipfile.md) *
- [flipfind](https://npm.io/package/flipfind.md) *
- [fliphash](https://npm.io/package/fliphash.md) *
- [sleepfor](https://npm.io/package/sleepfor.md) *
- [flipchain](https://npm.io/package/flipchain.md) *
- [json-chain](https://npm.io/package/json-chain.md) *
- [configstore](https://npm.io/package/configstore.md) *
- [node-localstorage](https://npm.io/package/node-localstorage.md) 1.3.0

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 0.0.12 (latest) — 2017-04-16
- 0.0.11 — 2017-04-13
- 0.0.10 — 2017-04-12
- 0.0.6 — 2017-04-06
- 0.0.5 — 2017-04-06
- 0.0.4 — 2017-04-05
- 0.0.3 — 2017-04-04
- 0.0.2 — 2017-04-04
- 0.0.1 — 2017-04-01

## README

# 💾💸 flipcache


[![NPM version][flipcache-image]][flipcache-url]
[![MIT License][license-image]][license-url]
[![fliphub][gitter-badge]][gitter-url]
[![flipfam][flipfam-image]][flipfam-url]

[flipcache-image]: https://img.shields.io/npm/v/flipcache.svg
[flipcache-url]: https://npmjs.org/package/flipcache
[license-image]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat
[license-url]: https://spdx.org/licenses/MIT
[gitter-badge]: https://img.shields.io/gitter/room/fliphub/pink.svg
[gitter-url]: https://gitter.im/fliphub/Lobby
[flipfam-image]: https://img.shields.io/badge/%F0%9F%8F%97%20%F0%9F%92%A0-flipfam-9659F7.svg
[flipfam-url]: https://www.npmjs.com/package/flipfam

> [temporary], safe, restorable, cacheable, configurable, chainable/fluent data

## 📦 usage
```bash
yarn add flipcache
npm i flipcache --save
```

```js
const flipcache = require('flipcache')
```

## 📘 examples

```js
const onthefly = flipcache
  .from('fromfile').end()
  .to('otherfile')
  .autoRemove(2000)
```

```js
const mocha = flipcache
  .from('mochaOptsFile').end()
  .to('mochaOptsBackupFile')
  .autoRestore(2000)
```

```js
const datas = flipcache
  .from('./index.js')
  .load()
  .json()
  .update({eh: true})
  .parse() // optional, is done for you
  .clean()
  .write()
```

### 👣 dir

```js
const datas = flipcache
  .from('./index.js')
  .dir(__dirname)
  .json()
  .setIfNotEmpty({eh: true})
  .write()
```

### 👽 exports

```js
const {
  File,
  Files,
  Core,
  Cache,
  JSONChain,
  ConfigStore,
  FlipFind,
  fliphash,
} = require('flipcache')
```

## 🔗 more
- for json, [json-chain][json-chain] is used
- for resolving paths (unless .dir is used), [flipfind][flipfind] is used
- for all fs operations, [flipfile][flipfile] is used

[json-chain]: https://www.npmjs.com/package/json-chain
[flipfind]: https://www.npmjs.com/package/flipfind
[flipfile]: https://www.npmjs.com/package/flipfile

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