Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asd-xiv/m
Point free style, functional library for Javascript with focus on object arrays.
https://github.com/asd-xiv/m
functional javascript library point-free
Last synced: about 10 hours ago
JSON representation
Point free style, functional library for Javascript with focus on object arrays.
- Host: GitHub
- URL: https://github.com/asd-xiv/m
- Owner: asd-xiv
- License: mit
- Created: 2017-08-30T23:58:19.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-12T14:59:45.000Z (over 1 year ago)
- Last Synced: 2024-10-30T18:49:07.606Z (9 days ago)
- Topics: functional, javascript, library, point-free
- Language: JavaScript
- Homepage: https://asd-xiv.github.io/m/
- Size: 7.2 MB
- Stars: 4
- Watchers: 4
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://circleci.com/gh/asd-xiv/m)
[](https://badge.fury.io/js/%40asd14%2Fm)
[](https://coveralls.io/github/asd-xiv/m)
# m
> [Point free](https://en.wikipedia.org/wiki/Tacit_programming) style,
> functional library for Javascript with focus on object arrays.
---
- [Install](#install)
- [Use](#use)
- ["With" pattern](#with-pattern)
- [|> pipe](#-pipe)
- [Develop](#develop)
- [Contributors](#contributors)
- [Changelog](#changelog)
## Install
```bash
npm install @asd14/m
```
## Use
```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)
)
```
## "With" pattern
Some functions have a `*With` variant. `find` has `findWith`, `filter` has
`filterWith` 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}
// ]
```
## |> pipe
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](https://medium.com/@cwodtke/the-intuitive-and-the-unlearnable-cccffd9a762)
- 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)
```
## Develop
```bash
git clone [email protected]:asd14-xyz/m.git && \
cd m && \
npm run setup
# run tests (any `*.test.js`) once
npm test
# watch `src` folder for changes and run test automatically
npm run tdd
```
## Contributors
Thank you for contributing your time and knowledge:
- [David Gil](https://github.com/dgilperez)
## Changelog
See the [releases section](https://github.com/asd14-xyz/m/releases) for details.