/adonis-auditable

Audit models in AdonisJS

Primary LanguageJavaScriptMIT LicenseMIT

adonis-auditable

Audit models in AdonisJS

How to use

Install npm module:

$ adonis install adonis-auditable

Register provider

Once you have installed adonis-auditable, make sure to register the provider inside start/app.js in order to make use of it.

const providers = [
  'adonis-auditable/providers/AuditableProvider'
]

Using the module:

Add the following to your model's boot method:

class MyModel extends Model {
  boot () {
    super.boot()
    this.addTrait('@provider:Auditable')
  }
}

This you can start using as follows:

// create
const model = await MyModel.audit().create({name: 'John'})

// update
const model = MyModel.find(1)
await model.audit().update({name: 'Simon'})

// delete
const model = MyModel.find(1)
await model.audit().delete()

Built With

Versioning

SemVer is used for versioning. For the versions available, see the tags on this repository.

Authors

License

This project is licensed under the MIT License - see the LICENSE file for details.

Changelog

  • v2.0.1

    • Removed need to pass in ctx parameters.
    • Update README and instructions.md files.

  • v2.0.0

    • Removed ctx injection on boot. ctx parameters need to be passed in manually now.
    • Updated README to reflect new changes.
    • Added this changelog.

  • v1.0.1

    • Initial release.