hamaca v0.3.2

hamaca.js

A data-reactive library

Getting Started

Install

npm i hamaca

Usage

import $ from 'hamaca';

const name = $('World');
const message = name.to(name => `Hello, ${name}`);
console.log(message.get());
name.set('hamaca.js');
console.log(message.get());

Methods

get

Returns the current data's value. If within a syncable function (i.e. to, watch, $.calc, $.sync), this will cause the function to be called again any time the value changes.

const flag = $(true);
$.sync(() => console.log(flag.get() ? 'Flag is set' : 'Flag not set'));

set

Modifies the data, and triggers updates to any dependent syncable functions.

const flag = $(true);
flag.set(false);

modify

Pass a modifying function to modify the data

const items = $(['One', 'Two']);
items.modify(items => items.push('Three'));

watch

Calls function each time the value is changed

const count = $(0);
count.watch(n => console.log(`Count: ${n}`));
for (let n = 1; n < 3; n++) {
  count.set(n);
}
// Outputs
//   Count: 0
//   Count: 1
//   Count: 2

to

Converts one data to another

const n = $(2);
const squared = n.to(n => n * n);
squared.watch(nn => console.log(`Square: ${nn}`));
n.set(3);
// Outputs
//   Square: 4
//   Square: 9

Functions

These are functions on $

$.ensure

Ensures that a value is a data object

const squared = n => $.ensure(n).to(n => n * n);
const a = squared(2);.
const b = squared(a);
console.log(a.get(), b.get());  // Output: 4, 16

$.ensureAll

Converts an array of values that may or may not be data objects to an array of data objects

const sum = (...args) => {
  const datas = $.ensureAll(args);
  return $.calc(() => datas.reduce((sum, data) => sum + data.get(), 0));
};
const a = $(1);
const b = sum(a, 2);
const c = sum(a, b, 3);
console.log(a.get(), b.get(), c.get());  // Outputs: 1, 3, 7
a.set(2);
console.log(a.get(), b.get(), c.get()); // Outputs: 2, 4, 9

$.getAll

Resolves each data item in an array

const a = $(2);
const b = a.to(a => a + 1);
const c = $.calc(() => a.get() * b.get());
console.log($.getAll([a, b, c]));  // Outputs: [2, 3, 6]

$.calc

Calculates a data object based on other data objects

const n = $(2);
const exp = $(8);
const pow = $.calc(() => Math.pow(n.get(), exp.get()));
console.log(pow.get());  // Outputs: 256
n.set(9)
exp.set(2);
console.log(pow.get());  // Outputs: 81

$.sync

Calls function any time a used data object changes

const n = $(2);
const exp = $(8);
$.sync(() => {
  console.log(`${n.get()}^${exp.get()} = ${Math.pow(n.get(), exp.get())}`);
});
n.set(9)
exp.set(2);
// Outputs:
//   2^8 = 256
//   9^8 = 43046721
//   9^2 = 81