mini-runner

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 58)

A simple alternative to events, signals and callbacks with an emphasis on performance.

mini-runner Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# mini-runner
A simple alternative to events and signals with an emphasis on performance.

Can be used as an alternative to events / signals.

[![Build Status](https://travis-ci.org/GoodBoyDigital/mini-runner.svg?branch=master)](https://travis-ci.org/GoodBoyDigital/mini-runner)

# How to use:
```js
var onComplete = new MiniRunner('onComplete');

//listenerObject needs to have a 'onComplete' function
onComplete.add(listenerObject);

//emit and all listeners will have their 'onComplete' functions called
onComplete.emit(data);
```

Can be used to execute a funcition on many objects. Handy for games. If you need to update you game elements each frame:

```js
var updateRunner = new MiniRunner('update');

// gameItems should all have a 'update' function
updateRunner.add(gameItem1);
updateRunner.add(gameItem2);
updateRunner.add(gameItem3);

// update game elements..
updateRunner.emit();
```
# Features:
- Easy to use familiar API.
- Under the hood it dynamically creates a looping function that is highly optimised. 
- Avoids using 'call' and runs the function directly (which is faster!).
- You can pass parameters when emitting.

Pros:
- Doesn't rely on strings.
- Code-completion works properly.
- Trying to dispatch or listen to an event type that doesn't exist throws errors (helps you find errors early).
- No need to create constants to store string values.
- Easy to identify which signals the object dispatch.
- Favor composition over inheritance.
- Doesn't mess with the prototype chain.
- Its fast, a lot faster than events and signals.
- Great for when performance matters.
- Its light weight, with a tiny memory footprint (smaller than events and signals)

Cons:
- Not quite as flexible. All listeners / items in the runner must have the correct function name specified within the runners constructor.

# When to use:
In practice I have found the MiniRunner increadibly useful and so thought it would be nice to share with the world. It currently forms the backbone of the messaging system in our game engine. Its working out great for things like update events, collison events etc.

Great to use if you are say looping through and array and calling the same function on each object. The resulting code is cleaner than a loop whilst still keeping the performance as fast as possible.

So yeah, if you are dispatching signals/events to a lot of listeners often (like everyframe often), then I would considor using this alternative. For most cases, this performace boost is not really important enough to switch from your current fave.

Think of this as a nice alternative for when speed really counts!

# Benchmarks
![benchmark results](https://photos-6.dropbox.com/t/2/AAAHAFu3cvFlEYVMrklzp-yaaR8OnEZpbSDFJL5-cTKgtg/12/636750047/png/32x32/3/1489708800/0/2/Screenshot%202017-03-16%2019.25.01.png/EOm5o5UFGKwJIAcoBw/2zJLuApgU9ujHA4gHbdnJvkq-8aud28HagayhL7nYJQ?dl=0&size=2048x1536&size_mode=3)

to run the tests, move to the runner-benchmark folder then run the following:
```bash
npm run benchmark
```

Next open you browser (http://localhost:9966). The test is run in the console.
The test result above comes from macbook pro chrome 58.

Any thoughts or comments hit me up on twitter [@doormat23](https://twitter.com/doormat23), I'd love to hear them!

mini-runner

mini-runner Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

mini-runner

mini-runner Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README