mere

0.5.3 • Public • Published

Build Status Known Vulnerabilities

Mere - library for JavaScript

Library that allows to bind functions to the string-formed tasks (JavaScript's Strings) and then execute functions through their related tasks. Together with this, a collection of associated tools is attached.

Installation

npm i mere --save

Usage

In our context tasks are mappings { string : function } or their derivatives. The world "derivative" means all task combinations that can be achieved through using such methods as
"task".task
"task".with(...)
"task".then(...)
[task1, task2, ...]
and some other

Require Mere library
require("mere");
Bind a function
"task name".bind((arg1, arg2, ...) => {
    /* some logic */
});
 
"task name".bind(task); /* bind from another task  */

Also .bind() returns a string that was binded to the function.

Execute a task
const res = "task name".make(arg1, arg2, ...); /* may throw Errors! */
Return a task wrapped in promise
const promise = "task name".promise(arg1, arg2, ...); /* errors will call the promise's reject branch! */
Return a task with inlined first n arguments
const newTask = "task name".with(arg1, arg2, ..., argn); /* return a task with last input arguments starts from n+1 */
Return a task that will call another task after (put the first result as the first argument of the second one, if result !== undefined)
const newTask = "first task name".then("second task name", arg1_or_2, arg2_or_3, ...); /* return a chained task with no input arguments for the first one */

i.e newTask takes arguments for the first task and after takes the result (if exist) and args in .then() for the second task.

Put arguments as a dictionary
"task name".bind((arg1, ..., argn) => {...});
 
"task name".make({
    arg1 : ...,
    ...
    argn : ...
});
 
/* and even this way */
 
"task name"
    .with({
     arg1 : ...,
     arg3 : ...
    })
    .with({
     arg2 : ...,
        arg4 : ...
    }),
    ...
    .make();
Put one task as the argument for another one

The code below will execute the task given as an argument:

const res = "task with one arg".make("second task name".task); /* if second task has no arguments */
 
const res = "task with one arg".make("second task name".with(arg1, arg2, ...)); /* otherwise */

If it is necessary to give a task as argument without execution (as is):

const res = "task with one arg".make("second task name".frozenTask);
Try interesting combinations
const promise = "first task name".then("second task name", secondArgs...).with(firstArgs...).promise(lastargs...);

That one is stupid, but You will do it better!

Task arrays also want to be in the topic!
["task name 1", "task name 2", "task name 3"].make();
["task name 1", "task name 2", "task name 3"].promise();
 
/* as fact, it works the same as the next code: */
"task name 1".then("task name 2").then("task name 3").make();
"task name 1".then("task name 2").then("task name 3").promise();
 
/* task arrays as arguments */
"first task name".make(["second task name", "third task name"].task);
 
/* and even task arrays in task arrays! */
["task name 1", ["task name 2"], "task name 3"].make();

Note that task arrays have methods .then_() and .with() that are corresponding to .then() and .with() respectively.

Wrap task array into a generator
/* each next(args) executes a task and returns a value */
["task name 1", "task name 2", "task name 3"].generate(); /* equally: generate(false) */
 
/* each next(args) executes a task with the first argument from the previous result
 * and put given args starting from the second formal argument; returns a value.
 * If previous result === undefined, the first argument will not be put this way. */ 
["task name 1", "task name 2", "task name 3"].generate(true);
 
/* works the same as */
"task name 1".then("task name 2", args2).then("task name 3", args3).make(args1);
/* and */
["task name 1".with(args1), "task name 2".with(args2), "task name 3".make(args3)].make();
Force return Promise from make()
"task name".makeAnyway(args); /* can return both Promise or not Promise  */
"task name".make(args); /* can return non-Promise values and Promises but when Mere configuration accepts  */
Memoization
task.memoize();

Application will save the result for each argument combination. Note that responsibility of task memoization is laid on user. Excess arguments are removed when checking memoization data, as well as missing arguments are put undefined.

Four properties

All tasks have four special properties accessed by <task>.<property>:

  1. .task - return the task itself. Useful in such case as "...".task to get the binded task.
  2. .frozenTask - return new task which returns the parent task. Useful when want to put a task as an argument:
"task 1".make("task 2");            // will put "task 2" as is, as a string argument 
"task 1".make("task 2".task);       // will execute "task 2" with no args and put its result (if "task 2" returns a promise, then "task 1" will return a promise, too, but be careful with make() method for this
"task 1".make("task 2".frozenTask); // will put "task 2".task as the argument, without executing it
  1. .promiseTask - wraps potential task result into a promise, that is why after this task will return only promises.
  2. .deadTask - forces the task not to return anything (in case of promise - return empty in resolve() or an error in reject()). This is useful when the task returns some extra data, for instance
"put data".bind((key, value) => {
    const prevData = dataContainer[key];
    
    dataContainer[key] = value;
    return prevData; /* returns the previous data binded to the key. Not necessary in most cases */
});
 
/* .deadTask forces not to pass the result into the next task as the first argument */
"put data".deadTask.then("...", arg1, ...).make(...);
 
Additional options / Mere configuring
const mere = require("mere");
 
console.log(mere.getArgCheck()); /* return 1 === mere.NOT_MORE */
 
/* if argument number must equal with the formal argument number (or an Error occurred) */
mere.setArgCheck(mere.MUST_EQUAL);
 
/* if argument number must not be more than the formal argument number (or an Error occurred) */
mere.setArgCheck(mere.NOT_MORE); /* the default setting */
 
/* if argument number must not be less than the formal argument number (or an Error occurred) */
mere.setArgCheck(mere.NOT_LESS);
 
/* if We don't want to think about argument number mismatch */
mere.setArgCheck(mere.NO_CHECK);
 
/* if we want to throw Error when make() attempts to return a Promise  */
mere.setMakeReturnPromiseAllowed(true); /* the default setting is false */
 
/* clear all string bindings */
mere.clearTasks();

Examples

Hello-world
require("mere");
 
"say hello-world".bind(() => {
    console.log("Hello, world!");
});
 
"say hello-world".make();
Sum two numbers
require("mere");
 
"sum".bind((num1, num2) => num1 + num2);
 
console.log("sum".make(2, 3));
 
"sum".promise(2, 3).then(
    (res) => {
     console.log(res);
    },
    (error) => {
        console.log("That is impossible!");
    });
Checking on being a task
require("mere");
 
"is task".bind((obj) => {
    if (obj && obj.constructor && obj.constructor.name === "MereTask") /* MereTask - class of all tasks */
        return true;
 
    return false;
});
"test task".bind(() => {});
 
console.log("is task".make("test task".task));       /* false, because 'test task' result will be put instead */
console.log("is task".make("test task".frozenTask)); /* true, because frozen tasks will not being executed */
Fibonacci with memoization
require("mere");
 
"fib".bind((k) => {
    if (<= 2)
        return 1;
    
    return "fib".make(- 1) + "fib".make(- 2);
});
 
"fib".memoize();
 
console.log("fib".make(50));
Sum and call
require("mere");
 
"sum"  .bind((num1, num2) => num1 + num2);
"print".bind((msg) => {
    console.log(msg);
});
 
"sum".then("print").make(2, 2);
Number doubler
require("mere");
 
"mult"  .bind((num1, num2) => num1 * num2);
"double".bind("mult".with(2));
 
console.log("double".make(2));
Faggot thrower
require("mere");
 
"print".bind((msg) => {
    console.log(msg);
});
 
"who I am".bind(() => "you are a faggot");
 
"print".make("who I am".task);
/* or what is equally (almost: first one will execute the task later in some cases): */
"print".make("who I am".make());
/* or even this way */
"who I am".then("print").make();
Some arithmetic
require("mere");
 
"sum" .bind((num1, num2) => num1 + num2);
"mult".bind((num1, num2) => num1 * num2);
 
console.log(["sum", "mult".with(2)].make(2, 2)); /* I hope You know that is eight */
Sum generators
require("mere");
 
"sum".bind((num1, num2) => num1 + num2);
 
let gen = ["sum", "sum"].generate(); /* is equal to generate(false) */
 
console.log(gen.next([2, 3]).value);   /* 5 */
console.log(gen.next([20, 30]).value); /* 50 */
 
gen = ["sum", "sum"].generate(true);
 
console.log(gen.next([2, 3]).value); /* 5 */
console.log(gen.next(20).value);   /* 25 */
Printing five messages with partial argument filling
require("mere");
 
"print 5 messages".bind((m1, m2, m3, m4, m5) => {
    console.log(m1);
    console.log(m2);
    console.log(m3);
    console.log(m4);
    console.log(m5);
});
 
"print 5 messages"
    .with({
     m1 : "Hello,",
     m4 : "five",
     m3 : "is"
    })
    .with({ m5 : "lines" })
    .make({ m2 : "this" });
Infinity adder
require("mere");
 
"adder".bind((...summands) => {
    let res = 0;
    
    for (let i = 0; i < summands.length; i += 1)
        res += summands[i];
    
    return res;
});
 
let task = "adder";
 
for (let i = 0; i < 1000; i += 1)
    task = task.with(i); /* or task = task.with({ summands : [i] }); */
 
console.log(task.make());
Force a promise return
require("mere");
 
"promisify".bind((func, ...args) =>
    new Promise((resolve, reject) => {
        try {
         resolve(func(...args));
        } catch (err) {
         reject(err);
        }
    }));
 
"promisify".makeAnyway((num1, num2) => num1 + num2, 2, 2).then(
    (res) => {
        console.log(res);
    }
);
Don't do this things
require("mere");
 
"lol".bind(() => "lol".make());
"lol".task.task.with().with().task.task;
[[], [].task, [].with()].make();
 

Because of its inanity.

Package Sidebar

Install

npm i mere

Weekly Downloads

2

Version

0.5.3

License

MIT

Last publish

Collaborators

  • glados