senecajs/seneca-entity-history

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# @seneca/entity-history 0.2.0

[![npm version](https://badge.fury.io/js/%40seneca%2Fentity-history.svg)](https://badge.fury.io/js/%40seneca%2Fentity-history)
[!![Build](https://github.com/senecajs/seneca-entity-history/workflows/build/badge.svg)](https://github.com/senecajs/seneca-entity-history/actions?query=workflow%3Abuild)
[![Coverage Status](https://coveralls.io/repos/github/senecajs/seneca-entity-history/badge.svg?branch=main)](https://coveralls.io/github/senecajs/seneca-entity-history?branch=main)
[![Maintainability](https://api.codeclimate.com/v1/badges/0b1990c4264d66b01c50/maintainability)](https://codeclimate.com/github/senecajs/seneca-entity-history/maintainability)
[![DeepScan grade](https://deepscan.io/api/teams/5016/projects/14231/branches/259194/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=5016&pid=14231&bid=259194)

<!--JOSTRACA-SLOT-START:shortdesc-->
Version history for entities
<!--JOSTRACA-SLOT-END:shortdesc-->

| ![Voxgig](https://www.voxgig.com/res/img/vgt01r.png) | This open source module is sponsored and supported by [Voxgig](https://www.voxgig.com). |
|---|---|



# Notes

* `is_finder:true` field in sys/entver allows current version details to be loaded directly. Thus there is always one more entry than the actual number of versions.



<!--START:options-->


## Options

* `` : object <i><small>"&nbsp;"</small></i>


Set plugin options when loading with:
```js


seneca.use('entity-history', { name: value, ... })


```


<small>Note: <code>foo.bar</code> in the list above means 
<code>{ foo: { bar: ... } }</code></small> 



<!--END:options-->

<!--START:action-list-->


## Action Patterns

* [role:entity,cmd:save](#-roleentitycmdsave-)
* [sys:enthist,enthist:list](#-sysenthistenthistlist-)
* [sys:enthist,entity:restore](#-sysenthistentityrestore-)


<!--END:action-list-->

<!--START:action-desc-->


## Action Descriptions

### &laquo; `role:entity,cmd:save` &raquo;

No description provided.



----------
### &laquo; `sys:enthist,enthist:list` &raquo;

No description provided.



----------
### &laquo; `sys:enthist,entity:restore` &raquo;

No description provided.



----------


<!--END:action-desc-->