loopback-softdelete

    1.0.1 • Public • Published

    NPM

    Loopback SoftDelete

    This module is designed for the Strongloop Loopback framework. It allows entities of any Model to be "soft deleted" by adding deletedAt and isDeleted attributes. Queries following the standard format will not return these entities; they can only be accessed by adding { isDeleted: true } to qutheery object (at the same level as where, include etc).

    Install

    NPM
      npm install --save loopback-softdelete
    YARN
      yarn add loopback-softdelete

    Configure

    Add the mixins property to your server/model-config.json:

    {
      "_meta": {
        "sources": [
          "loopback/common/models",
          "loopback/server/models",
          "../common/models",
          "./models"
        ],
        "mixins": [
          "loopback/common/mixins",
          "../node_modules/loopback-softdelete",
          "../common/mixins"
        ]
      }
    }

    To use with your Models add the mixins attribute to the definition object of your model config.

      {
        "name": "project",
        "plural": "projects",
        "base": "PersistedModel",
        "properties": {
          "name": {
            "type": "string",
            "required": true
          }
        },
        "mixins": {
          "SoftDelete" : true,
        },
      },

    Retrieving deleted entities

    To run queries that include deleted items in the response, add { isDeleted: true } to the query object (at the same level as where, include etc).

    Testing

    Run tests using this command.

      npm test

    Install

    npm i loopback-softdelete

    DownloadsWeekly Downloads

    226

    Version

    1.0.1

    License

    MIT

    Last publish

    Collaborators

    • krapans