type-enforcer/src/Removable.js

A type enforcement library for javascript

import methodQueue from './methods/methodQueue';
import PrivateVars from './utility/PrivateVars';

const _ = new PrivateVars();

/**
 * A mixin that adds methods to a class to facilitate clean-up
 *
 * ``` javascript
 * import { Removable } from 'type-enforcer';
 *
 * class MyClass extends Removable {}
 * ```
 *
 * @class Removable
 */
export default class Removable {
	/**
	 * Calls all the onRemove callbacks and sets isRemoved to true
	 *
	 * @method remove
	 * @instance
	 */
	remove() {
		const self = this;

		if (self && !self.isRemoved) {
			_.set(self, true);

			const onRemove = self.onRemove();

			if (onRemove) {
				onRemove.trigger().discardAll();
			}
		}
	}

	/**
	 * If the returned value is true then remove has been called.
	 *
	 * @memberOf Removable
	 * @instance
	 *
	 * @returns {Boolean}
	 */
	get isRemoved() {
		return Boolean(_(this));
	}
}

Object.assign(Removable.prototype, {
	/**
	 * Adds a callback to a [Queue](docs/Queue.md) that gets triggered when the "remove" method is called
	 *
	 * @method onRemove
	 * @instance
	 *
	 * @arg {Function} callback
	 *
	 * @returns {Queue}
	 */
	onRemove: methodQueue()
});