import {MiniSignal} from 'mini-signals/src/mini-signals.js'

public class | source

MiniSignal

Constructor Summary

Public Constructor
public	constructor MiniSignal constructor.

Public Methods
public	add(fn: Function): MiniSignalBinding Register a new listener.
public	detach(node: MiniSignalBinding): MiniSignal Remove binding object.
public	detachAll(): MiniSignal Detach all listeners.
public	dispatch(): Boolean Dispaches a signal to all registered listeners.
public	handlers(exists: Boolean): MiniSignalBinding[] \| Boolean Return an array of attached MiniSignalBinding.
public	once(fn: Function): MiniSignalBinding Register a new listener that will be executed only once.

MiniSignal constructor.

let mySignal = new MiniSignal();
let binding = mySignal.add(onSignal);
mySignal.dispatch('foo', 'bar');
mySignal.detach(binding);

Name	Type	Attribute	Description
fn	Function		Callback function.

The MiniSignalBinding node that was added.

Remove binding object.

Name	Type	Attribute	Description
node	MiniSignalBinding		The binding node that will be removed.

The instance on which this method was called.

Detach all listeners.

The instance on which this method was called.

Dispaches a signal to all registered listeners.

Indication if we've emitted an event.

Return an array of attached MiniSignalBinding.

Name	Type	Attribute	Description
exists	Boolean	optional default: false	We only need to know if there are handlers.

Array of attached MiniSignalBinding or Boolean if called with exists = true

Name	Type	Attribute	Description
fn	Function		Callback function.

The MiniSignalBinding node that was added.