Comparing version 1.9.0 to 1.10.0
{ | ||
"name": "shades", | ||
"version": "1.9.0", | ||
"version": "1.10.0", | ||
"description": "Lens-like functionality with a lodash-style interface.", | ||
"main": "lib/index.js", | ||
"main": "lib/bundle.js", | ||
"module": "lib/bundle.es.js", | ||
"scripts": { | ||
"compile": "babel src --out-dir lib", | ||
"compile": "BABEL_ENV=build rollup -c && BABEL_ENV=build rollup -c --output.format=es --output.file=\"lib/bundle.es.js\"", | ||
"preversion": "npm test", | ||
"version": "npm run compile", | ||
"test": "mocha --compilers js:babel-register" | ||
"test": "BABEL_ENV=test mocha --require babel-core/register", | ||
"inspect": "BABEL_ENV=test mocha --require babel-core/register --inspect" | ||
}, | ||
"bin": { | ||
"shades": "playground/index.js" | ||
}, | ||
"repository": { | ||
@@ -23,3 +28,4 @@ "type": "git", | ||
"reducer", | ||
"profunctor" | ||
"profunctor", | ||
"state management" | ||
], | ||
@@ -32,10 +38,7 @@ "author": "James McNamara", | ||
"homepage": "https://github.com/jamesmcnamara/shades#readme", | ||
"dependencies": { | ||
"lodash.get": "^4.4.2", | ||
"lodash.isequal": "^4.5.0", | ||
"lodash.mapvalues": "^4.6.0", | ||
"lodash.pickby": "^4.6.0" | ||
}, | ||
"dependencies": {}, | ||
"devDependencies": { | ||
"babel-cli": "^6.26.0", | ||
"babel-core": "6", | ||
"babel-plugin-external-helpers": "^6.22.0", | ||
"babel-plugin-lodash": "^3.3.2", | ||
@@ -46,5 +49,10 @@ "babel-preset-env": "^1.6.1", | ||
"chai": "^4.1.2", | ||
"mocha": "^3.0.2", | ||
"pegjs": "^0.10.0" | ||
"lodash": "^4.17.5", | ||
"mocha": "5.0.4", | ||
"pegjs": "^0.10.0", | ||
"rollup": "^0.56.5", | ||
"rollup-plugin-babel": "^3.0.3", | ||
"rollup-plugin-commonjs": "^9.0.0", | ||
"rollup-plugin-node-resolve": "^3.2.0" | ||
} | ||
} |
461
README.md
@@ -1,6 +0,19 @@ | ||
## shades | ||
Shades is a [lodash](https://github.com/lodash/lodash) inspired [lens](https://www.schoolofhaskell.com/school/to-infinity-and-beyond/pick-of-the-week/basic-lensing)-like library. | ||
![shades](imgs/shades.svg) | ||
## shades | ||
1. [intro](#intro) | ||
2. [playground](#try) | ||
2. [guide](#guide) | ||
3. [recipes](#recipes) | ||
1. [What's `has`?](#recipe-has) | ||
2. [How do I focus on just elements that match some condition?](#recipe-matching) | ||
3. [What if I want to perform multiple updates at once?](#recipe-updateAll) | ||
3. [Does this work with a library like Redux?](#recipe-redux) | ||
4. [When should I reach for this library?](#recipe-when) | ||
4. [api](#api) | ||
A lens is a path into an object, which can be used to extract its values, or even "modify" them in place (by creating a new object with the value changed). | ||
<a name="intro"></a> | ||
Shades is a [lodash](https://github.com/lodash/lodash) inspired [lens](https://www.schoolofhaskell.com/school/to-infinity-and-beyond/pick-of-the-week/basic-lensing)-like library. | ||
A lens is a path into an object, which can be used to extract its values, or even "modify" them in place (by creating a new object with the value changed). | ||
When writing immutable code, we very commonly end up with deeply nested data stores, e.g.: | ||
@@ -12,6 +25,6 @@ | ||
{ | ||
name: 'Jack Sparrow', | ||
name: 'Jack Sparrow', | ||
posts: [ | ||
{ | ||
title: 'Why is the rum always gone? A dissertation on Carribean trade deficit' | ||
title: 'Why is the rum always gone? An analysis of Carribean trade surplus' | ||
} | ||
@@ -36,4 +49,4 @@ ], | ||
users: store.users.map((user, idx) => ( | ||
idx === userIdx | ||
? {...user, | ||
idx === userIdx | ||
? {...user, | ||
posts: user.posts.map((post, idx) => | ||
@@ -51,3 +64,3 @@ idx === postIdx | ||
This is an enormous amount of obfuscating boiler plate code for a very simple update. | ||
This is an enormous amount of obfuscating boiler plate code for a very simple update. | ||
@@ -60,16 +73,350 @@ With lenses, we could write this update much more declaratively: | ||
(store) | ||
``` | ||
## <a name="try"></a>Try It Out | ||
shades contains a little node playground that you can use to follow along with the guide or generally mess around with it. | ||
You can run it with [`npx`](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b)(which you already have if you're running `npm@^5.2.x`): | ||
```sh | ||
npx shades | ||
``` | ||
Or the old fashioned way | ||
```sh | ||
npm install --global shades | ||
shades | ||
``` | ||
## <a name="guide"></a> Let's Talk About Lens, Baby | ||
For reference, we will use the following object: | ||
<a name="store"></a> | ||
```js | ||
const store = { | ||
users: [ | ||
{ | ||
name: 'Jack Sparrow', | ||
goldMember: false, | ||
posts: [ | ||
{ | ||
title: 'Why is the rum always gone? An analysis of Carribean trade surplus', | ||
likes: 5, | ||
} | ||
] | ||
}, | ||
{ | ||
name: 'Elizabeth Swan', | ||
goldMember: true, | ||
posts: [ | ||
{ | ||
title: 'Bloody Pirates - My Life Aboard the Black Pearl', | ||
likes: 10000, | ||
} | ||
] | ||
} | ||
] | ||
} | ||
``` | ||
#### Baby's first lens | ||
Conceptually, a lens is something that represents a path through an object. | ||
The simplest lens is a string path, like `'name'`, or `'address.streetName'`. | ||
`get` is the simplest lens consumer. It takes a lens into an object, and produces a function that will take an object, and produce the focus of that lens. Using the `store` from above: | ||
```js | ||
> const getName = get('users[0].name') | ||
> getName(store) | ||
'Jack Sparrow' | ||
``` | ||
or more succinctly: | ||
```js | ||
> get('users[0].name')(store) | ||
'Jack Sparrow' | ||
``` | ||
or less succinctly (multiple lenses can be passed in and they will be composed left-to-right): | ||
```js | ||
> get('users', '[0]', 'name')(store) | ||
'Jack Sparrow' | ||
``` | ||
This is all well and good, but that `'[0]'` is unrealistic. We rarely know _which_ index of an array we need to edit. Thus we need a way to focus on multiple points in an array (or object) | ||
#### Baby's first traversal | ||
This is where stuff starts to get interesting. | ||
[Traversals](#traversals) split the focus of lenses into _multiple_ focus points. These can be particularly helpful when working with arrays. | ||
The simplest traversal is `all`. `all` focuses on every element of an array (or every value in an object). | ||
```js | ||
> get('users', all, 'posts')(store) | ||
[ | ||
[ { title: 'Why is the rum always gone? An analysis of Carribean trade surplus', likes: 5} ], | ||
[ { title: 'Bloody Pirates - My Life Aboard the Black Pearl', likes: 10000 } ] | ||
] | ||
``` | ||
Traversals can be used anywhere a lens is used. However, as you can see above, when `all` appears in a composition, everything after is applied to every element of a collection, instead of on a single object. In this way, traversals act like prisms: | ||
![Dark Side](imgs/dark-side.jpeg) | ||
Multiple traversals can be composed into a single lens. Each traversal in the lens will result to a further level of nesting in the output | ||
```js | ||
> get('users', all, 'posts', all, 'likes')(store) | ||
[[5], [100000]] | ||
``` | ||
Above, we focused on the `users` key of the store, then for every user in the `users` array we focused on the posts array, and then for every post in THAT array we focused on the `likes` key. | ||
`all` will always produce an array in the output, and so we got an array for when we traversed over `users`, and another nested array when we traversed over `posts`. Pretty neat, huh? | ||
#### Modifications | ||
`get`ting data is all well and good, but where shades really shines is performing immutable updates. The good news is everything we have learned up until now translates seamlessly. | ||
Meet `mod`. `mod` is a lot like `get`: it accepts lenses and produces a function. The difference is, before we pass `mod` an object to act on, we pass it a function that transforms the focus of the lens. Then we pass it an object, and instead of producing the focus of the object (like `get`) it will produce a copy of the entire object, with the focus of the lens transformed by your function. | ||
```js | ||
> const tranformer = mod('users[0].posts[0].likes')(likes => likes + 1) | ||
> transformer(store) | ||
{ | ||
users: [ | ||
{ | ||
name: 'Jack Sparrow', | ||
goldMember: false, | ||
posts: [ | ||
{ | ||
title: 'Why is the rum always gone? An analysis of Carribean trade surplus', | ||
likes: 6, // <---- Incremented!! | ||
} | ||
] | ||
}, | ||
{ | ||
name: 'Elizabeth Swan', | ||
goldMember: true, | ||
posts: [ | ||
{ | ||
title: 'Bloody Pirates - My Life Aboard the Black Pearl', | ||
likes: 10000, | ||
} | ||
] | ||
} | ||
] | ||
} | ||
``` | ||
This transform was done immutably, so our original `store` is unmodified. | ||
`mod` also works with traversals: | ||
```js | ||
> mod('users', all, 'posts', all, 'likes')(likes => likes + 1)(store) | ||
{ | ||
users: [ | ||
{ | ||
name: 'Jack Sparrow', | ||
goldMember: false, | ||
posts: [ | ||
{ | ||
title: 'Why is the rum always gone? An analysis of Carribean trade surplus', | ||
likes: 6, // <---- Incremented!! | ||
} | ||
] | ||
}, | ||
{ | ||
name: 'Elizabeth Swan', | ||
goldMember: true, | ||
posts: [ | ||
{ | ||
title: 'Bloody Pirates - My Life Aboard the Black Pearl', | ||
likes: 10001, // <---- Also Incremented!! Wow! | ||
} | ||
] | ||
} | ||
] | ||
} | ||
``` | ||
## <a name="recipes"></a>Recipes | ||
#### <a name="recipe-has"></a> What's `has`? | ||
Great question! [`has`](#has) is a very simple, but very useful, utility. | ||
`has` is a predicate factory function. It takes a pattern of keys and values and produces a predicate. The predicate takes a test value and returns `true` if the given test value has at least the equivalent keys and values of the pattern. Using the [store](#store) example from above: | ||
```js | ||
> const [jack, elizabeth] = store.users | ||
// Tests if an object passed to it has the key goldMember mapped to true | ||
> const isGoldMember = has({goldMember: true}) | ||
> isGoldMember(jack) | ||
false | ||
> isGoldMember(elizabeth) | ||
true | ||
``` | ||
Where `has` gets interesting is when the values in your pattern are predicate functions. In this case, the value at that key in the test object is passed to the function, and validation only continues if that function returns `true` | ||
```js | ||
> const [jack, elizabeth] = store.users | ||
// Tests if the object passed to it has a title attribute that is less than 50 letters long | ||
> const hasShortTitle = has({title: title => title.length < 50}) | ||
> get('users', all, 'posts', matching(hasShortTitle))(store) | ||
[ { title: 'Bloody Pirates - My Life Aboard the Black Pearl', likes: 10000} ] | ||
``` | ||
#### <a name="recipe-matching"></a>How do I focus on just elements that match some condition? | ||
You want the traversal factory [`matching`](#matching). `matching` takes a predicate (`a => Boolean`) and produces a traversal that only focuses on elements for which the predicate is true. | ||
```js | ||
> get('users', matching(user => user.goldMember), 'posts')(store) | ||
[ { title: 'Bloody Pirates - My Life Aboard the Black Pearl', likes: 10000} ] | ||
``` | ||
`matching` tends to combine nicely with [`has`](#recipe-has): | ||
```js | ||
> mod('users', matching(has({goldMember: true})), 'posts', all, 'likes')(store) | ||
{ | ||
users: [ | ||
{ | ||
name: 'Jack Sparrow', | ||
goldMember: false, | ||
posts: [ | ||
{ | ||
title: 'Why is the rum always gone? An analysis of Carribean trade surplus', | ||
likes: 5, // <---- not updated, not gold member | ||
} | ||
] | ||
}, | ||
{ | ||
name: 'Elizabeth Swan', | ||
goldMember: true, | ||
posts: [ | ||
{ | ||
title: 'Bloody Pirates - My Life Aboard the Black Pearl', | ||
likes: 10001, // <---- updated, goldMember | ||
} | ||
] | ||
} | ||
] | ||
} | ||
``` | ||
#### <a name="recipe-updateAll"></a> What if I want to perform multiple updates at once? | ||
You want the transformer combinator [`updateAll`](#updateAll). `updateAll` takes an arbitrary number of `S => S` functions, and produces a transformer that will apply each one in turn. | ||
```js | ||
> const [jack] = store.users | ||
> const promotion = updateAll( | ||
set('goldMember')(true), | ||
mod('posts', all, 'likes')(inc) | ||
) | ||
> promotion(jack) | ||
{ | ||
name: 'Jack Sparrow', | ||
goldMember: true, // <---- gold status, what what! | ||
posts: [ | ||
{ | ||
title: 'Why is the rum always gone? An analysis of Carribean trade surplus', | ||
likes: 6, // <---- Incremented!! | ||
} | ||
] | ||
} | ||
``` | ||
#### <a name="recipe-redux"></a> Does this work with a library like [Redux](https://redux.js.org/)? | ||
Absolutely. Most functions in `shades` are [curried](https://www.sitepoint.com/currying-in-functional-javascript/), so they take a little massaging to work with other libraries. For example a reducer for the `ADD_LIKES` action might look like this: | ||
```js | ||
// Assuming this function is only called when the type === 'ADD_LIKES' | ||
function (state, {numLikes, name, title}) { | ||
return mod('users', matching(has({name})), 'posts', matching(has({title}) ), 'likes') // find the post the action is referencing | ||
(add(numLikes)) // add the number of likes to the current likes | ||
(state) // pass in the current state | ||
} | ||
``` | ||
This is much more understandable than: | ||
```js | ||
function (state, {numLikes, name, title}) { | ||
return { | ||
...state, | ||
users: state.users.map(user => | ||
user.name !== name | ||
? user | ||
: { | ||
...user, | ||
posts: user.posts.map(post => | ||
post.title !== title | ||
? post | ||
: { | ||
...post, | ||
likes: post.likes + numLikes, | ||
}) | ||
}) | ||
} | ||
} | ||
``` | ||
But we can do even better. Many Redux actions are simple setters so they look like this: | ||
```js | ||
// (S, A) => S | ||
function(state, value) { | ||
return set('visible')(value)(state) | ||
} | ||
``` | ||
This reducer takes a value, and sets a predefined path on the state to that value. This is still a lot of code for a very simple update. The reason is that the reducer has a signature of `(S, A) => S`, but our setter has signature `L => A => S => S` (L=lens, A=field type, S=state type) | ||
If we define our reducers to be `A => S => S` though, besides being hilarious, we find some very nice simplifications: | ||
```js | ||
// A => S => S | ||
function (value) { | ||
return function (state) { | ||
return set('visible')(value)(state) | ||
} | ||
} | ||
``` | ||
Rewritten using arrow syntax: | ||
```js | ||
// A => S => S | ||
value => state => set('visible')(value)(state) | ||
``` | ||
Lets focus on the inner `state => set('visible')(value)(state)`. Remember (or prove to yourself) that `x => f(x)` is the same as `f`. Thus | ||
```js | ||
// S => S | ||
state => set('visible')(value)(state) | ||
``` | ||
is the same as | ||
```js | ||
// S => S | ||
set('visible')(value) | ||
``` | ||
They are both functions from `S => S`, one is just explicit, and the other is not. | ||
Substituting that in, we get | ||
```js | ||
// A => S => S | ||
value => set('visible')(value) | ||
``` | ||
Now, look at that last line, and the argument above, and you should be able to see that the last line is equivalent to: | ||
```js | ||
// A => S => S | ||
set('visible') | ||
``` | ||
That's it. That's our entire, dynamic reducer. | ||
_If you like this idea, please let me know in the [issues](https://github.com/jamesmcnamara/shades/issues). I have another library for intergrating shades with Redux and reducing boilerplate, and I'd love to get feedback_ | ||
#### <a name="recipe-when"></a>When should I reach for this library? | ||
Think of this library as lodash for functions. It provides many utility functions and patterns for [pointfree programming](https://en.wikipedia.org/wiki/Tacit_programming) and immutable updates. It is in no way supposed to be a replacement for [lodash](https://lodash.com/) or [lodash/fp](https://github.com/lodash/lodash/wiki/FP-Guide). In fact, it is intended to be used WITH those libraries (lodash/fp in particular). | ||
As such, this library tends to be the most useful in data pipeline code - long transformation chains in lodash, [Rx.js](http://reactivex.io/rxjs/), complex updates in [Redux](https://redux.js.org/), etc. | ||
Most of the time when you are transforming data, `shades` will be able to make your code a little more declarative ;) | ||
## API | ||
#### lens | ||
A lens is simply a string which describes a path into an object. It can include object accesses and array indicies. | ||
A lens is a path into an object. It can include object accesses and array indicies. | ||
The `focus` of the lens is the final value referenced in the path. | ||
The focus of the lens is the final value referenced in the path. | ||
Lenses can be constructed with the [lens](#lens) function, or passed as string literals into the lens consumer functions ([get](#get), [set](#set), [mod](#mod)) | ||
Combining lenses with ES6 template strings can be a concise way to use environment variables to create a dynamic path. | ||
_For more powerful dynamic or mutlifoci lenses, check out [traversals](#traversals)._ | ||
_For more powerful, dynamic, or mutlifoci lenses, check out [traversals](#traversals)._ | ||
@@ -83,3 +430,3 @@ ```js | ||
#### <a href='get'>get :: (String or Lens) -> obj -> focus</a> | ||
#### <a name='get'></a>get :: (...Lens) => obj => focus | ||
`get` consumes a lens and produces a function that takes in an object `obj` and outputs the focus of its lens. | ||
@@ -92,3 +439,3 @@ | ||
#### <a href='set'>set :: (String or Lens) -> a -> obj -> obj</a> | ||
#### <a name='set'></a>set :: (...Lens) => a => obj => obj | ||
`set` consumes a lens and produces a function that takes in a constant value `const`, and produces a function consuming an object `obj` and outputs a clone of `obj` with the focus of the lens replaced with `const` | ||
@@ -101,3 +448,3 @@ | ||
#### <a href='mod'>mod :: (String or Lens) -> (a -> a) -> obj -> obj</a> | ||
#### <a name='mod'></a>mod :: (...Lens) => (a => a) => obj => obj | ||
`mod` consumes a lens and produces a function that takes in a modifiying function `m` for the focus of the lens, and produces a function consuming an object `obj`, then outputs a clone of `obj` with the focus of the lens replaced with `m`'s output. | ||
@@ -111,19 +458,7 @@ | ||
#### <a href='lens'>lens :: String -> Lens</a> | ||
`lens` consumes a path into an object and produces a corresponding lens function. All lens consumers ([get](#get), [set](#set), [mod](#mod)) will accept a literal string. However, lenses are composable via [compose](#compose), so lenses can be built piece by piece. | ||
#### <a href='compose'>compose :: (Lens or String)* -> Lens</a> | ||
`compose` composes the foci of multiple lenses | ||
_Note: It is unlikely that you will ever need to call this directly_ | ||
```js | ||
> const l = compose('.a.b', '.c.d') | ||
> get(l)({a: {b: {c: {d: 10}}}}) | ||
10 | ||
``` | ||
### <a href='traversals'>Traversals</a> | ||
### <a name='traversals'></a>Traversals | ||
Traversals are lenses that have multiple focus points. These can be multiple elements in an array or multiple keys in an object. They can all still be used with the lens functions described above. | ||
#### matching :: (a -> Boolean) -> Lens | ||
#### <a name="matching"></a>matching :: (a => Boolean) => Lens | ||
`matching` consumes a predicate and produces a lens which will act over every element which returns `true` for the predicate. | ||
@@ -133,3 +468,3 @@ | ||
> const even = n => n % 2 == 0 | ||
> get(matching(even))([1, 2, 3, 4]) | ||
> get(matching(even))([1, 2, 3, 4]) | ||
[2, 4] | ||
@@ -145,3 +480,3 @@ > get(matching(even))({a: 1, b: 2, c: 3, d: 4}) | ||
``` | ||
#### unless :: (a -> Boolean) -> Lens | ||
#### unless :: (a => Boolean) => Lens | ||
`unless` is the opposite of `matching`. It consumes a predicate and produces a lens which will act over every element which returns `false` for the predicate. | ||
@@ -151,3 +486,3 @@ | ||
> const even = n => n % 2 == 0 | ||
> get(all))([1, 2, 3, 4]) | ||
> get(all))([1, 2, 3, 4]) | ||
[1, 3] | ||
@@ -160,16 +495,18 @@ | ||
#### all :: Lens? -> Lens | ||
`all` is the identity traversal. It acts over every element. It optionally takes an additional lens, and for each element in the result set will apply the given lens. | ||
_Note: this is only necessary for `get`. `mod` and `set` will already do the appropriate thing if `all` appears in the middle of a lens | ||
#### all :: Lens | ||
`all` is the identity traversal. It acts over every element. | ||
```js | ||
> const mul10 = n => n * 10 | ||
> mod(all())(mul10)({a: 1, b: 2, c: 3, d: 4}) | ||
> mod(all)(mul10)([1, 2, 3, 4]) | ||
[10, 20, 30, 40] | ||
> mod(all)(mul10)({a: 1, b: 2, c: 3, d: 4}) | ||
{a: 10, b: 20, c: 30, d: 40} | ||
> const even = n => n % 2 == 0 | ||
> get('a', all('b.c'))({a: [{b: {c: 1}}, {b: {c: 2}}, {b: {c: 3}}]}) | ||
> get('a', all, 'b.c')({a: [{b: {c: 1}}, {b: {c: 2}}, {b: {c: 3}}]}) | ||
[1, 2, 3] | ||
> mod('a', all(), 'b.c')(mul10)({a: [{b: {c: 1}}, {b: {c: 2}}, {b: {c: 3}}]}) | ||
> mod('a', all, 'b.c')(mul10)({a: [{b: {c: 1}}, {b: {c: 2}}, {b: {c: 3}}]}) | ||
[10, 20, 30] | ||
@@ -182,4 +519,4 @@ | ||
### Utils | ||
#### has :: Object -> Object -> boolean | ||
`has` is a predicate construction function. It takes a pattern of keys and values and produces a function that takes value and returns `true` if the given value at least has equivalent keys and values the given pattern | ||
#### <a name="has"></a> has :: any => any => boolean | ||
`has` is a predicate factory function. It takes a pattern of keys and values and produces a function that takes value and returns `true` if the given value at least has equivalent keys and values the given pattern | ||
@@ -196,5 +533,5 @@ ```js | ||
> const id = 5 | ||
> const users = [{id: 1, name: 'Elizabeth', likes: 1,000,000,000}, {id: 3, name: 'Bootstrap Bill', likes: 12}, {id: 5, name: 'Jack', likes: 41}] | ||
> const users = [{id: 1, name: 'Elizabeth', likes: 1000000000}, {id: 3, name: 'Bootstrap Bill', likes: 12}, {id: 5, name: 'Jack', likes: 41}] | ||
> mod(matching(has({id})), '.likes')(inc)(users) | ||
[{id: 1, name: 'Elizabeth', likes: 1,000,000,000}, {id: 3, name: 'Bootstrap Bill', likes: 12}, {id: 5, name: 'Jack', likes: 42}] | ||
[{id: 1, name: 'Elizabeth', likes: 1000000000}, {id: 3, name: 'Bootstrap Bill', likes: 12}, {id: 5, name: 'Jack', likes: 42}] | ||
``` | ||
@@ -207,4 +544,4 @@ | ||
``` | ||
#### map :: (a, ?c -> b) -> (List a | Object c, a) -> (List b | Object c, b) | ||
A more generic, curried `map`. If applied to a list, it behaves like `Array::map`. Applied to a an object, it transforms the values (although the key will be supplied as a second argument) | ||
#### map :: (a => b) => List a => List b | (a, ?c => b) => Object c a => Object c b | ||
A more generic, curried `map`. If applied to a list, it behaves like `Array::map`. Applied to an object, it transforms the values (although the key will be supplied as a second argument) | ||
@@ -219,4 +556,4 @@ ```js | ||
#### filter :: (a, ?c -> boolean) -> (List a | Object c, a) -> (List b | Object c, b) | ||
A more generic, curried `filter`. If applied to a list, it behaves like `Array::filter`. Applied to a an object, it filters based on the values (although the key will be supplied as a second argument) | ||
#### filter :: (a => Boolean) => List a => List a | (a, ?c => Boolean) => Object c a => Object c a | ||
A more generic, curried `filter`. If applied to a list, it behaves like `Array::filter`. Applied to an object, it filters based on the values (although the key will be supplied as a second argument) | ||
@@ -230,3 +567,3 @@ ```js | ||
``` | ||
#### updateAll :: ...Transformers s -> s -> s | ||
#### <a name="updateAll"></a>updateAll :: ...Transformers s => s => s | ||
Consumes a variadic number of transformers (i.e. `Lens`es that have already been applied to a path and a transforming function) and a state function and applies each of them in order to a state object, producing a transformed object | ||
@@ -255,3 +592,3 @@ ```js | ||
#### toggle :: bool -> bool | ||
#### toggle :: bool => bool | ||
Negates a boolean | ||
@@ -262,3 +599,3 @@ ```js | ||
``` | ||
#### inc :: Num -> Num | ||
#### inc :: Num => Num | ||
Increments a number | ||
@@ -269,3 +606,3 @@ ```js | ||
``` | ||
#### <a href="#cons">cons</a> :: a -> Array a -> Array a | ||
#### <a name="cons"></a>cons :: a => Array a => Array a | ||
Consumes an element `x` and an array `xs` and returns a new array with `x` APPENDED to `xs` (not prepended, which is more typical with `cons` and lists. This is to make it easier to use in pipelined scenarios) | ||
@@ -277,6 +614,6 @@ ```js | ||
#### push :: a -> Array a -> Array a | ||
#### push :: a => Array a => Array a | ||
Alias for [`cons`](#cons) | ||
#### <a href='concat'>concat</a> :: Array a -> Array a -> Array a | ||
#### <a name='concat'></a>concat :: Array a => Array a => Array a | ||
Takes two arrays and concatenates the first on to the second. | ||
@@ -287,6 +624,6 @@ ```js | ||
``` | ||
#### append :: Array a -> Array a -> Array a | ||
#### append :: Array a => Array a => Array a | ||
Alias for [`concat`](#concat) | ||
#### prepend :: Array a -> Array a -> Array a | ||
#### prepend :: Array a => Array a => Array a | ||
Takes two arrays and concatenates the second on to the first. | ||
@@ -299,3 +636,3 @@ ```js | ||
#### and :: (...(...args) -> boolean) -> (...args) -> boolean | ||
#### and :: (...(...args) => boolean) => (...args) => boolean | ||
A function level equivalent of the `&&` operator. It consumes an arbitrary number of functions that take the same argument types and produce booleans, and returns a single function that takes the same arguments, and returns `true ` if all of the functions return `true` | ||
@@ -309,3 +646,3 @@ | ||
``` | ||
#### or :: (...(...args) -> boolean) -> (...args) -> boolean | ||
#### or :: (...(...args) => boolean) => (...args) => boolean | ||
A function level equivalent of the `||` operator. It consumes an arbitrary number of functions that take the same argument types and produce booleans, and returns a single function that takes the same arguments, and returns `true ` if any of the functions return `true` | ||
@@ -318,3 +655,3 @@ ```js | ||
``` | ||
#### not :: ((...args) -> boolean) -> (...args) -> boolean | ||
#### not :: ((...args) => boolean) => (...args) => boolean | ||
A function level equivalent of the `!` operator. It consumes a function that produces a boolean, and returns a function that takes the same arguments, and returns the negation of the output | ||
@@ -324,3 +661,3 @@ ```js | ||
``` | ||
#### always :: a -> b -> a | ||
#### always :: a => b => a | ||
Produces the given value forever | ||
@@ -331,3 +668,3 @@ ```js | ||
``` | ||
#### flip :: (a -> b -> c) -> (b -> a -> c) | ||
#### flip :: (a => b => c) => (b => a => c) | ||
Takes a 2-curried function and flips the order of the arguments | ||
@@ -334,0 +671,0 @@ ```js |
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Debug access
Supply chain riskUses debug, reflection and dynamic code execution features.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
346683
0
7507
647
15
10
1
1
- Removedlodash.get@^4.4.2
- Removedlodash.isequal@^4.5.0
- Removedlodash.mapvalues@^4.6.0
- Removedlodash.pickby@^4.6.0
- Removedlodash.get@4.4.2(transitive)
- Removedlodash.isequal@4.5.0(transitive)
- Removedlodash.mapvalues@4.6.0(transitive)
- Removedlodash.pickby@4.6.0(transitive)