Make any JavaScript object a chainable, functional interface.
This library is intentionally tiny and dependency free. The entire library, minified is less than 1kb!
Make the tiny Mitt event library chainable
import chainable from '../lib/chainable.js';
import mitt from 'mitt';
let emitter = chainable(mitt)
.on('blarp', ()=> { /* Handle blarp emit */ })
.on('flonk', ()=> { /* Handle flonk emit */ })
.emit('blarp')
.value() // Get original unwrapped emitter
Make a browser DOM element chainable
import chainable from '@momsfriendlydevco/chainable';
// Make a chainable DOM object
chainable(document.createElement('div'));
.addEventListener('click', ()=> { /* Handle clicks */ })
.set('style.position', 'absolute') // Set a deeply nested property
.value() // Output the original object (if needed)
This library exists this because handling chainability in some non-chainable interfaces gets repetitive.
// Horrible <div> setup using the native DOM
let widget = document.createElement('div');
widget.addEventListener('click', ()=> { /* Handle click */ });
widget.style.position = 'absolute';
widget.style.top = '0px';
widget.style.left = '0px';
widget.classList.add('red');
document.body.append(widget);
// Equivalent using chainable
document.append(
chainable(document.createElement('div'));
.addEventListener('click', ()=> { /* Handle clicks */ })
.set('style.position', 'absolute') // Set a deeply nested property
.set('style.top', '0px')
.set('style.left', '0px')
.call('classList.add', 'red')
.value() // Output the original raw DOMElement
);
Create a new chainable instance.
This also sets $source
to the original object.
Also available as chainable.source
if there isn't any conflict with the name.
The chainable source object.
Generally you don't want to access this directly.
Also available as chainable.call(name, ...args)
if there isn't any conflict with the name.
As with .$get
the name can be in dotted notation or array notation for deeply nested methods.
Call a method on source but ignore the response and return the chainable instance.
Also available as chainable.set(key, val)
if there isn't any conflict with the name.
Set one or more properties within a source object.
Can be called as a simple key/val setter - chainable.$set(keyName, value)
- or as an object - chainable.$set({key1: val1, key2: val2})
The key can also use dotted notation (e.g. this.is.a.nested.key
) or an array notation (e.g. ['this', 'is', 'a', 'nested', 'key']
) to set deeply nested properties.
Returns the chainable instance.
Also available as chainable.get(path)
if there isn't any conflict with the name.
Fetch a value from the source object, returning it.
The path can also use dotted notation (e.g. this.is.a.nested.key
) or an array notation (e.g. ['this', 'is', 'a', 'nested', 'key']
) to get deeply nested properties.
Returns the value found at the path or undefined if none.
Also available as chainable.value()
if there isn't any conflict with the name.
Return the original source object - i.e. unwrap the original.
Also available as chainable.tap(callback)
if there isn't any conflict with the name.
Run a callback inline as (chainable) => { /* handler */ }
, ignore the result and return the chainable instance.
Also available as chainable.tap(callback)
if there isn't any conflict with the name.
Run a callback inline as (chainable) => { /* handler */ }
, take the returned value as the new $source
and and return the chainable instance.