Fractal-objects NPM

Fractal Objects

Installation

Install Fractal Objects to the development dependencies of your project:

# With NPM
npm install --save-dev fractal-objects

# With Yarn
yarn add fractal-objects --dev

Usage

import { fold } from 'fractal-objects';

// Fractal object #1
const part1 = { arrayKey: [1], objectKey: { a: 'a', b: 'b' } };
// Fractal object #2
const part2 = { arrayKey: [2, 3], objectKey: { c: 'c' } };
// Fractal object #3
const part3 = { arrayKey: [4] }

// View multiplication of the fractal objects #1, #2, and #3
console.log(fold([part1, part2, part3]));
// Output:
// { arrayKey: [ 1, 2, 3, 4 ], objectKey: { a: 'a', b: 'b', c: 'c' } }

Concept

A fractal object is an object that has self-similarity at lower scales. Multiplication of two fractal objects results in a new fractal object that has the same shape as the original ones.

If we multiply fractal objects in a list pairwise, we'll receive a new fractal object, which will represent all the fractal objects in the list and which will also have the same shape.

By default, the multiplication function provided by the fractal-objects package multiplies two objects by concatenating their array values, merging object values, and replacing scalars with values from the second multiplied object.

Any other multiplication function can be used if it has the following properties:

It keeps the object shape: The multiplicands and the result must have the same shape and type.
It's associative. For example, multiplying (a b) c must have the same result as multiplying a (b c).
It must yield the result a when multiplying undefined a or a undefined.

In terms of mathematics, fractal objects are a semigroup.