@wizhut_tech/wizjs 0.0.2 → 0.0.4

package/__tests__/lang_singleton.test.js

@@ -1,7 +1,7 @@
 const t = require('tap');
 
 
-const { getInstance, addSingleton } = require('../src/lang/singleton.js');
+const { getInstance, singleton } = require('../src/lang/singleton.js');
 
 
 t.test('singleton/null-test', async (t) => {
@@ -12,11 +12,11 @@ t.test('singleton/null-test', async (t) => {
 
 t.test('singleton/simple-tests', async (t) => {
     // numbers
-    addSingleton('number-wrapper', async () => 1);
+    singleton('number-wrapper', async () => 1);
     t.equal(await getInstance('number-wrapper'), 1)
 
     // null
-    addSingleton('null-wrapper', async () => null);
+    singleton('null-wrapper', async () => null);
     t.equal(await getInstance('null-wrapper'), null);
 
     t.end();

package/docs/lang_checks.md

@@ -0,0 +1,5 @@
+# Lang / Checks
+
+Import as `require('wizjs/lang/checks.js')`.
+
+* **isNil(arg)**: Check if the `arg` is `undefined` or `null` and returns `true` (or `false` otherwise).

package/docs/lang_flow.md

@@ -0,0 +1,3 @@
+# Lang / flow
+
+**Still in development**

package/docs/lang_singleton.md

@@ -0,0 +1,10 @@
+# Lang / Singleton
+
+Import with `require('wizjs/lang/singleton.js')`. In-memory caching of an async function's result, ensuring that it will be called only once.
+
+Mimics similar python decorators. It can easily, be used to store class instance variables.
+
+### Module API
+
+* **singleton(name, fn)**: register an `async` function (`fn`) by name.
+* **getInstance(name)**: returns the instance for a specific `name`. Note that the `fn` is executed only when this method is called.

package/docs/math_numbers.md

@@ -0,0 +1,5 @@
+# Math / Numbers
+
+Import as `require('wizjs/math/numbers.js')`.
+
+* **toInteger(arg)**: Attempts to convert `arg` to `Integer`. Return `0` if the arg is `zero` or invalid value.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wizhut_tech/wizjs",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "main": "index.js",
   "devDependencies": {
     "tap": "21.0.1"

package/readme.md

@@ -1,5 +1,13 @@
 # Wizjs
 
-A Javascript library (a few selected dependencies only) that contains utilities for enjoy-full every day programming.
+A Javascript library (a few selected dependencies only) that contains utilities for enjoy-full every day programming. No, this library will not become another `lodash` :).
 
-## Usage
+### Language
+
+* Checks ... [documentation](docs/lang_checks.md)
+* Flow ... [documentation](docs/lang_flow.md)
+* Singleton ... [documentation](docs/lang_singleton.md)
+
+### Math
+
+* Numbers ... [documentation](docs/math_numbers.md)

package/src/lang/flow.js

@@ -0,0 +1,17 @@
+
+
+class TransactionItem {
+    constructor(task, fallback) {
+        this.task = task;
+        this.fallback = fallback;
+    }
+
+    async execute() {
+        
+    }
+}
+
+
+module.exports = {
+
+};

package/src/lang/singleton.js

@@ -1,3 +1,4 @@
+const { isNil } = require('./checks.js');
 
 
 const instances = {};
@@ -5,17 +6,17 @@ const wrappers = {};
 
 
 
-function addSingleton(name, fn) {
+function singleton(name, fn) {
     wrappers[name] = fn;
 }
 
 
 async function getInstance(name){
-    if (instances[name] !== undefined) {
+    if (!isNil(instances[name])) {
         return instances[name];
     }
 
-    if (wrappers[name] === undefined) {
+    if (isNil(wrappers[name])) {
         return null;
     }
 
@@ -29,6 +30,6 @@ async function getInstance(name){
 
 
 module.exports = {
-    addSingleton,
+    singleton,
     getInstance
 }

package/src/math/numbers.js

@@ -1,4 +1,3 @@
-
 const { isNil } = require('../lang/checks.js');