# ng-vault

> Helper methods wrapped over angular $cacheFactory

Latest version **0.4.0** (published 2017-02-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install ng-vault
pnpm add ng-vault
yarn add ng-vault
bun add ng-vault
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2017-02-08 |
| First published | 2017-02-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+10 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Vijay Dev |
| Maintainers | vijaydev |
| Keywords | vault, cache, $cacheFactory, caching, cache once, cache upto, angular |

## Links

- npm: https://www.npmjs.com/package/ng-vault
- Repository: https://github.com/iamvijaydev/ng-vault
- Homepage: https://github.com/iamvijaydev/ng-vault#readme
- Issues: https://github.com/iamvijaydev/ng-vault/issues
- npm.io page: https://npm.io/package/ng-vault

## Dependencies (1)

- [angular](https://npm.io/package/angular.md) ^1.6.1

## 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.4.0 (latest) — 2017-02-08
- 0.3.1 — 2017-02-07
- 0.3.0 — 2017-02-07
- 0.2.0 — 2017-02-07

## README

# ng-vault [![npm version](https://badge.fury.io/js/ng-vault.svg)](https://badge.fury.io/js/ng-vault)
===========
ng-vault wraps over angular's `$cacheFactory` to provide few nifty ways to save and retrieve data. ng-vault contains these two parts:
* `$vault` factory which has methods for storing and retrieving data.
* `$vaultConfigProvider` for configuring the behaviour of `$vault` factory.


# Installation
###Via yarn or npm:
```shell
# yarn (recommended)
$ yarn add ng-vault

#npm
$ npm install ng-vault --save
```
Then use it as:
```javascript
var angular = require('angular');
angular.module('mainApp', [ require('ng-vault') ]);
```
###Via bower:
```
$ bower install ng-augment-native-scroll --save
```
Then use it as:
```javascript
var angular = require('angular');
var ngAugmentNativeScroll = require('./bower_components/ng-vault/src');

angular.module('mainApp', ['ng-vault']);
```
You can also include it in the old fashion way as:
```html
<script src="/bower_components/ng-vault/dist/ng-vault.js"></script>
<!-- or -->
<script src="/bower_components/ng-vault/dist/ng-vault.min.js"></script>
```


# Provider Configuration
Normally we may not need to configure the behaviour of `$vault`. Still he is an example of how we can do it:
```javascript
angular.module('mainApp')
    .config(function ($vaultConfigProvider) {
        $vaultConfigProvider.set({
            id: 'starwars',
            limitTypes: {
                isArray: true,
                isDate: true,
                isFunction: true,
                isNumber: true,
                isObject: true,
                isString: true
            },
            putUptoMins: 5
        });
    });
```

### id - type:`String` - default:`$vault`
The unique name with which the internal `store` of `ng-vault` will be created.

### limitTypes - type:`Array` - default:`[]`
By default we can save any type of data into `$cacheFactory`, `$vault` can be configured to accept only the configured types. This can be help control `$vault` usage. Skip this to allow `$vault` to save all type of data. The key names in options, `isArray`, `isDate`... are the same methods available on angular. Internally `$vault` uses `angular.<key name>` to check types. Using plain `typeof type === typeof vaule` can produce inconsistent results.

### putUpto - type:`Number` - default:`3`
Using when we put some data in, it will be retained as long as it's not removed. But sometime we may want to retain data only for a short while. It should be removed once the time is up. We can use `putUpto` method to put data with an additional `mins` argument. Here `putUptoMins` can be set as the default value to be used, in case `putUpto` is not provided with an additional `mins` argument.


# Usage
Now we can inject `$vault` into any other part of our code to `put` and `get` values. Here are the list of all methods that `$vault` packs:

### put
To put data in, only defined data. It will check the data type with the set `limitTypes`. If it passed it will saved. If not it will display a console warn.

Param | Type | Required | Details
--- | :--- | :--- | :---
key | String | yes | Name of the key
value | Any | yes | Value to be saved

```javascript
$vault.put('episode-4', 'A New Hope');
```

### putUpto
Put for certain time, after which it will be removed

Param | Type | Required | Details
--- | :--- | :--- | :---
key | String | yes | Name of the key
value | Any | yes | Value to be saved
mins | Number | no | Mins after which the data should be removed

```javascript
$vault.putUpto('episode-5', 'The Empire Strikes Back', 5);

// after 5 mins (5 * 1000 * 60)
$vault.has('episode-5');
// false
```

### putOnce
Put value and remove once it's retrieved.

Param | Type | Required | Details
--- | :--- | :--- | :---
key | String | yes | Name of the key
value | Any | yes | Value to be saved

```javascript
$vault.putOnce('episode-6', 'Return of the Jedi');

$vault.get('episode-6');
// Return of the Jedi

$vault.has('episode-6');
// false
```

### get
Get a stored data. If not found it will return `undefined`.

Param | Type | Required | Details
--- | :--- | :--- | :---
key | String | yes | Name of the key

```javascript
$vault.get('episode-2');
// Attack of the Clones
```

### has
Check if a particular key exist. Returns `true` or `false`.

Param | Type | Required | Details
--- | :--- | :--- | :---
key | String | yes | Name of the key

```javascript
$vault.has('episode-3');
// true
```

### remove
Remove a key from `$vault`

Param | Type | Required | Details
--- | :--- | :--- | :---
key | String | yes | Name of the key

```javascript
$vault.remove('episode-1');
```

### info
Retrieve information regarding the store - id and size

```javascript
$vault.info();
// {
//     id: 'starwars',
//     size: 5
// }
```

### removeAll
Remove everything from `$vault`

```javascript
$vault.removeAll();
```


# TODO
Testing and code-coverage


#Future
Data is still stored in memory. Add methods to save them to `localStorage` or `indexedDB`.

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