npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

objection-paranoia

v1.0.3

Published

A Objectionjs plugin to add soft delete.

Downloads

200

Readme

objection-paranoia

npm(https://www.npmjs.com/package/objection-paranoia)

Automatically handle soft-deleting with your Objection.js models.

Installation

Install from npm:

npm install objection-paranoia

Register the plugin with an instance of objection:

const objectionSoftDelete = require('objection-paranoia');
objectionSoftDelete.register(objection);

Configuration

By default, objection-paranoia uses the deleted_at attribute for soft-deletes. You can optionally pass in an options object as the second argument to register to specify a custom attribute to use:

objectionSoftDelete.register(objection, {
  columnName: 'deleted_at',
});

Options

columnName: the name of the column to use as the soft delete flag on the model (Default: 'deleted_at'). The column must exist on the table for the model.

You can specify different column names per-model by using the options:

objectionSoftDelete.register(objection, {
  columnName: 'deleted_at',
  deletedValue: new Date() | knex.fn.now(),
  notDeletedValue: null | true | false,
});

deletedValue: you can set this option to allow a different value than "new Date()" to be set in the specified column. For instance, you can use the following code to make a timestamp (you need knex instance to do so)

objectionSoftDelete.register(objection, {
  columnName: 'deleted_at',
  deletedValue: new Date() | knex.fn.now(),
});

notDeletedValue: you can set (and should) this option along with deletedValue to allow a different value than "null" to be set in the specified column. For instance, you can use the following code to restore the column to null (you need knex instance to do so)

objectionSoftDelete.register(objection, {
  columnName: 'deleted_at',
  deletedValue: new Date() | knex.fn.now(),
  notDeletedValue: null | true | false,
});

Usage

When soft-delete is enabled on a model, the delete timestamp will be set to new Date() on deletion.

Enable soft-delete for a model

Set the softDelete static property on your model to true:

class MyModel {
  static get softDelete() {
    return true;
  }
}

When softDelete is enabled, all delete queries to this model will instead update the model with a delete timestamp, and all queries to find these models will omit deleted instances.

Include deleted records in query

MyModel.query().withDeleted();

Force delete

MyModel.query().forceDelete();

Credits

objection-softdelete objection-soft-delete