@f0x52/chain
TypeScript icon, indicating that this package has built-in type declarations

0.0.1 • Public • Published

@f0x52/chain

A userland implementation of pipelines. Handles synchronous operations only.

Useful to make otherwise(deeply, nested(functionCalls(42)) a lot more readable. Also lets you combine object methods and stand-alone functions in a single chain of calls, instead of having to switch between wrapped calls and method calls, which gets messy very quickly with complex sequences of operations that you might want to split over multiple lines.

Adapted from syncpipe with slightly different API (spread instead of array of functions) and TypeScript types.

Example

A runnable version of this example can be found in example.js in the repository.

import chain from "@f0x52/chain";

const input = {
	a: "b",
	c: "d"
};

// reverse key/value pairs from object
const output = chain(
	input,
	// (_) => Object.entries(_),
	Object.entries,
	(_) => _.map(([k, v]) => [v, k]),
	// (_) => Object.fromEntries(_)
	Object.fromEntries
);

The _ is just a variable name here, you could call it anything you want - but giving it a consistent name will help with readability, as all of the arrow function bodies will be visually aligned.

API

syncpipe(input, ...functions)

Given an input and a series of functions that transform that value into a new value, passing it as input to the next function, returning the return value of the final function.

  • input: The initial value.
  • ...functions: Transformation functions, or a single transformation function (though that is somewhat pointless).

License, donations

GPL-3.0. If you want to support my work, you can: Donate using Liberapay

Changelog

v0.0.1 (February 12th, 2024)

Readme

Keywords

none

Package Sidebar

Install

npm i @f0x52/chain

Weekly Downloads

2

Version

0.0.1

License

GPL-3.0

Unpacked Size

39.2 kB

Total Files

6

Last publish

Collaborators

  • f0x52