Point free style, functional Javascript library with focus on object arrays
npm install @asd14/m
> Point free style,
> functional library for Javascript with focus on object arrays.
---
- Install
- Use
- "With" pattern
- |> pipe
- Develop
- Contributors
- Changelog
``bash`
npm install @asd14/m
`js
import { pipe, trim, split, dropLast, push, join } from "@asd14/m"
const removeTrailingSlash = source =>
source[source.length - 1] === sep ? source.slice(0, -1) : source
const renameFile = newName =>
pipe(
removeTrailingSlash,
split(sep),
dropLast,
push(trim(sep, newName)),
join(sep)
)
`
Some functions have a *With variant. find has findWith, filter hasfilterWith etc. They allow for less boilerplate and more intuitive way of
handling object arrays.
`js
import { find, findWith, filterWith, not, is } from "@asd14/m"
const todos = [
{ id: 1, name: "lorem", tagId: 2 },
{ id: 2, name: "ipsum", tagId: null },
{ id: 3, name: "dolor", tagId: null },
]
`
`js
/ Predicate fn /
find(item => item.id === 1, todos)
// => {id: 1, name: "lorem", tagId: 2}
/ Matching object /
findWith(
{
id: 1,
},
todos
)
// => {id: 1, name: "lorem", tagId: 2}
/ Matching object & predicate fn /
filterWith(
{
tagId: is, // same as tagId: source => is(source)
},
todos
)
// => [{id: 1, name: "lorem", tagId: 2}]
/ Syntactic sugar /
filterWith(
{
"!tagId": is, // same as tagId: not(is)
},
todos
)
// => [
// {id: 2, name: "ipsum", tagId: null},
// {id: 3, name: "dolor", tagId: null}
// ]
There is no _structure_ difference between pipe and compose, both will use
the same building blocks to get from A to B.
A series of transformations over an initial input can be written as
x -> f -> g -> result, _piping_, or as result = g(f(x)), _composing_. The
difference is only _syntactic_. Input is the same, transformations and order
of application are the same, the result will be the same.
Given that:
- we read from left to right
- left/back is in the past, right/front is the future
- a lot of piping going on in your terminal
it makes sense to choose the _syntax_ more aligned with our intuition and
context. The transformations are applied in a certain order with time as a
medium - input -> t0 -> t1 -> tn -> output.
`js
const { sep } = require("path")
const { pipe, compose, join, push, dropLast, split } = require("@asd14/m")
// Compose: g(f(x))
const renameFile = newName => filePath =>
compose(join(sep), push(newName), dropLast, split(sep))(filePath)
// Pipe: x -> f -> g
const renameFile = newName => filePath =>
pipe(split(sep), dropLast, push(newName), join(sep))(filePath)
// More expressive with pipeline operator
const renameFile = newName => filePath =>
filePath |> split(sep) |> dropLast |> push(newName) |> join(sep)
`
`bash
git clone git@github.com:asd14-xyz/m.git && \
cd m && \
npm run setup
) once folder for changes and run test automaticallyThank you for contributing your time and knowledge:
See the releases section for details.