@wizhut_tech/wizjs 0.0.3 → 0.0.5

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,3 @@
+# Lang / Checks
+
+* **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_functools.md

@@ -0,0 +1,3 @@
+## lang / functools
+
+* **reflexive(arg)**: Just a dumb method that returns `arg` as provided.

package/docs/lang_singleton.md

@@ -0,0 +1,8 @@
+# Lang / Singleton
+
+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,3 @@
+# Math / Numbers
+
+* **toInteger(arg)**: Attempts to convert `arg` to `Integer`. Return `0` if the arg is `zero` or invalid value.

package/index.js

@@ -1,12 +1,14 @@
 const singleton = require('./src/lang/singleton.js');
 const checks = require('./src/lang/checks.js');
 const numbers = require('./src/math/numbers.js');
+const functools = require('./src/lang/functools.js');
 
 
 module.exports = {
     lang: {
         singleton: singleton,
-        checks: checks
+        checks: checks,
+        functools: functools
     },
     math: {
         numbers: numbers

package/package.json

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

package/readme.md

@@ -1,5 +1,31 @@
 # 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
+Use by importing:
+
+`const wizjs = require('@wizhut_tech/wizjs')`. Returns an object structured like:
+
+```
+{
+    lang: {
+        checks: [functions],
+        singleton: [functions],
+        functools: [functions]
+    },
+    math: {
+        numbers: [functions]
+    }
+}
+```
+
+### Language
+
+* **Check** utility functions ... [[docs](docs/lang_checks.md)]
+* Control-**Flow** utilities ... [[docs](docs/lang_flow.md)] -- *still in development* --
+* **functools** ... [[docs](docs/lang_functools.md)]
+* **Singleton** hack ... [[docs](docs/lang_singleton.md)]
+
+### Math
+
+* Utilities around **numbers** ... [[docs](docs/math_numbers.md)]

package/src/lang/functools.js

@@ -0,0 +1,10 @@
+
+
+function reflexive(arg) {
+    return arg;
+}
+
+
+module.exports = {
+    reflexive
+}

package/src/lang/singleton.js

@@ -6,7 +6,7 @@ const wrappers = {};
 
 
 
-function addSingleton(name, fn) {
+function singleton(name, fn) {
     wrappers[name] = fn;
 }
 
@@ -30,6 +30,6 @@ async function getInstance(name){
 
 
 module.exports = {
-    addSingleton,
+    singleton,
     getInstance
 }