https://github.com/kchapelier/migl-pool
Micro Game Library : Object pool
https://github.com/kchapelier/migl-pool
Last synced: 28 days ago
JSON representation
Micro Game Library : Object pool
- Host: GitHub
- URL: https://github.com/kchapelier/migl-pool
- Owner: kchapelier
- License: mit
- Created: 2015-04-04T12:56:38.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-04-04T19:55:09.000Z (over 10 years ago)
- Last Synced: 2025-08-09T10:52:49.776Z (about 2 months ago)
- Language: JavaScript
- Size: 117 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# migl-pool
Micro Game Library : Object pool
The main use of the object pool pattern in javascript is to reduce the number of garbage collection by enforcing object reuse.
Garbage collection can be quite taxing for real time application such as games and cause dropped frames (jank).
This particular implementation of the object pool doesn't have a fixed size, new instances are dynamically added to the pool when needed.
For further information, check [gameprogrammingpatterns.com](http://gameprogrammingpatterns.com/object-pool.html) and [html5rocks.com](http://www.html5rocks.com/en/tutorials/speed/static-mem-pools/))
## Features
* Doesn't force a specific interface onto the pooled objects.
* Lightweight and simple.
## Basic example
### Pool creation for object literals :
```js
var pool = require('migl-pool');
var literalPool = pool.create({
allocationNumber: 5,
firstAllocationNumber: 10,
factory: function literalPoolFactory () {
return {
value: 0,
printValue: function () {
console.log(this.value);
}
};
},
initialize: function literalPoolInitialize (element, options) {
element.value = options.value;
}
});
var element = literalPool.get({ value: 2 });
element.printValue();
```
### Pool creation for classic prototype-based objects :
```js
var MyObject = function () {};
MyObject.prototype.value = null;
MyObject.prototype.printValue = function () {
console.log(this.value);
};
var pool = require('migl-pool');
var myObjectPool = pool.create({
allocationNumber: 5,
firstAllocationNumber: 10,
factory: function myObjectPoolFactory () {
return new MyObject();
},
initialize: function myObjectPoolInitialize (element, options) {
element.value = options.value;
}
});
var element = myObjectPool.get({ value: 2 });
element.printValue();
```
### General pool usage :
```js
// where somePool is an instance of Pool
var element = somePool.get({});
somePool.free(element); // place an element back into the pool of available instances
console.log(somePool.toString()); // retrieve information about the pool, useful for debugging purpose
somePool.clear(); //remove all the object from the pool
```
## Roadmap
* Make unit tests.
* Better doc.