@beardedtim/sorted-insert
v0.1.3
Published
A basic sorted insert for a list
Downloads
15
Readme
#Sorted Insert
Because going through the list is so 2001
This package is a simple function along with the tests. It uses list deconstruction and runs inside of node v7.4.0
. I am unsure of how it will work in versions lower than that or in the browser.
##Argument Order for insert
This has the argument order of (item,list,sortingFunction)
which may not be helpful for currying. However I think it works best for my use cases. If you use this function and find that another order is better suited for your use-case, feel free to make a PR/open an Issue and let's discuss it!
##Argument Order for fromSorted
This takes the function first and then the list second. This is because I can see me wanting to curry this function far more often than the insert function.
##Usage
$ yarn add @beardedtim/sorted-insert
And then in the project you want it
insert
const insert = require('@beardedtim/sorted-insert').insert,
list = [0,2],
item = 1,
withNewItem = insert(item,list) // [0,1,2]
Or if you want to pass in your own sorting function:
const friends = [
{
name: 'Chris'
},
{
name: 'Kristen'
},
{
name: 'Tim'
}
],
newFriend = {
name: 'Ryan'
},
sortingFun = (a,b) => a.name < b.name
insert(newFriend,friends,sortingFun)
// [
// {name: 'Chris'},
// {name: 'Kristen'},
// {name: 'Ryan'},
// {name: 'Tim'}
// ]
fromSorted
const fromSorted = require('@beardedtim/sorted-insert').fromSorted,
list = [0,1,2,3,4,5,6],
fn = a => a < 5 && a > 0,
wanted = fromSorted(fn,list) // [1,2,3,4]
##Tests
$ yarn run test