activable

Activable

A base class that implements active-related functionalities.

Install

$ npm install --save activable

Usage

import Activable from 'activable';

class Engine extends Activable {}

const engine = new Engine ();

engine.isActive (); // false
engine.activate ();
engine.isActive (); // true
engine.deactivate ();
engine.isActive (); // false

API

new Activable ( active?: boolean )

Returns a new instance of Activable, with a status of active, if provided, or false.

.isActive (): boolean

Returns a boolean indicating the state of the instance.

.activate (): this

.isActive () will return true.

.deactivate (): this

.isActive () will return false.

.toggleActive ( active: boolean = !this.isActive () ): this

If active is provided, the status will be set to its value. Otherwise it will flip the current value.

License

MIT © Fabio Spampinato