time-events-manager/README.md

View and Manage Javascript's timeout and interval collections

# time-events-manager
View and Manage Javascript's timeout and interval collections

# Installation

```$ npm install time-events-manager --save```


```html
<script src="../dist/main.min.js"></script>
```

# Usage

```javascript
// creating a timeout

function myFunc(){
    console.log("Hello world");
}

var myTimeoutId = setTimeout(myFunc, 5000); 

// Managing timeouts via timeoutCollection object

timeoutCollection.get(0);
timeoutCollection.getById(myTimeoutId); //Both returning the timeout object created

timeoutCollection.getScheduled(); //Returns an array of timeout objects that have not yet executed
timeoutCollection.getCompleted(); //Returns an array of timeout objects that have been executed
timeoutCollection.getAll(); //Returns an array of timeout objects

timeoutCollection.remove(myTimeoutId);
timeoutCollection.removeAll();
```

Basically, you should inject the library script from in place you would like the collection to work on.

# Why?

JavaScript will not expose us a simple object or array to view and manage all of our current `time-events`.
This library exposes the timeouts and intervals in your current page. In addition, it makes
it possible to manage those `time-events` in `run-time`.