asyngleton - npm Package Compare versions

Comparing version 0.0.0 to 0.0.1

lib/index.js

 var EventEmitter = require("events").EventEmitter;
 
-module.exports = function(fn) {
+/**
+ */
 
+function createAsyngleton(fn) {
+
 	var em = new EventEmitter(), singletonArgs, called;
@@ -43,5 +46,31 @@
 		called = false;
+		return ret;
 	}
 
 	return ret;
-};
+}
+
+/**
+ */
+
+function createDictionary() {
+
+	var _dict = {};
+
+	return {
+		get: function(key, fn) {
+			if(_dict[key]) return _dict[key];
+
+			var asyngleton = _dict[key] = createAsyngleton(fn);
+
+			asyngleton.dispose = function() {
+				delete _dict[key];
+			}
+
+			return asyngleton;
+		}
+	}
+}
+
+module.exports = createAsyngleton;
+module.exports.dictionary = createDictionary;

package.json

@@ -5,3 +5,3 @@ {
   "description": "asynchronously generate singletons",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "repository": {
@@ -8,0 +8,0 @@ "type": "git",

README.md

@@ -23,2 +23,65 @@ ### Example
 
-```
+```
+
+
+### API
+
+#### asyngleton(factory)
+
+Creates a new asyngleton function.
+
+- `factory` - the factory method for creating the singleton. This is called ONCE.
+
+#### .reset()
+
+Resets the target asyngleton so the factory can be called again.
+
+```javascript
+
+var fs     = require('fs'),
+asyngleton = require('asyngleton');
+
+var readDir = asyngleton(function(callback) {
+	fs.readdir(__dirname, callback);
+});
+
+readDir(function(err, files) {
+	
+	//make the readDir factory callable again
+	readDir.reset();
+
+	//do stuff...
+});
+
+```
+
+#### .dictionary()
+
+creates a dictionary of singletons
+
+```javascript
+
+var dict = require('asyngleton').dictionary(),
+fs = require('fs');
+
+var readThisDir = dict.get("readThisDir", function(onSingleton) {
+	fs.read(__dirname, onSingleton);
+});
+
+var readLibDir = dict.get("readLibDir", function(onSingleton) {
+	fs.read(__dirname + "/lib", onSingleton);
+})
+
+readThisDir(function(err, files) {
+	//do stuff
+});
+
+readLibDir(function(err, files) {
+	//do stuff
+});
+```
+
+#### dictionary.get(name, factory)
+
+- `name` - the name of the singleton in the dictionary
+- `factory` - the factory method incase the singleton doesn't exist

No alert changes

Improved metrics

Total package byte prevSize

3458

increased by79.73%

Lines of code

66

increased by43.48%

Number of lines in readme file

86

increased by273.91%

No dependency changes