waldojeffers / conductor Goto Github PK

To do

• map should accept an input string: map('key')
• map should accept an input path string to allow several level-deep plucking: map('data.errors.0')
• remove pluck

They should accept Functions or Booleans

or(true, false)() // true
or(n => n % 2 === 0, n => n % 1 === 0)(3) // true
or(false, n => n % 2 === 0)(3) // false

Dear WaldoJeffers,

May you develop a diff method, please?

Cheers.

Checklist

• It should work on Arrays, Sets, Objects, Maps
• Use it in equals source, and replace Array.prototype.every where necessary
• Document it

Checklist

• Title
• Short description
• Purpose (already done but should be moved to a separate document)
• Get started
• Examples
• Link to documentation
• Gitter?
• Further reading

Add a chunk method, like Lodash's

Checklist

• apply
• arity
• branch
• compose
• curry
• curryN
• filter
• findIndex
• flip
• forEach
• ifElse
• map
• reduce
• some
• transduce

Hello @WaldoJeffers ,

I think you make a mistake in your doc for "compose" section.
is not rather minus3 = 3-x ?

import {compose} from '@waldojeffers/conductor'
​
const times2 = x => 2 * x
const minus3 = x => 3 * x
const times2Async = async x => times2(x) // async keyword makes it return a Promise
const minus3Async = async x => minus3(x) // async keyword makes it return a Promise
​
compose(minus3, times2)(5) // 7
await compose(minus3Async, times2Async)(2, 5) // 7 : we need to await because it is an async function
await compose(minus3, times2Async) // 7
await compose(minus3Async, times2) // 7

Checklist

• always
• apply
• arity
• branch
• capitalize
• compose
• curry
• curryN
• delay
• dump
• entries
• filter
• findIndex
• flip
• forEach
• get
• head
• identity
• ifElse
• into
• isPromise
• iterate
• keys
• map
• next
• pluck
• prepend
• random
• reduce
• replace
• slice
• some
• then
• toLowerCase
• transduce
• transformers
  • filter
  • map
• type
• upsert
• values

Currently, awaitAll is only used internally by map.

Or has ? has vs hasProp ?

Currently there's no way to flatten a nested list such as [1, 2, [3, 4, [5, 6], [7, 8]]] into [1, 2, 3, 4, 5, 6 , 7, 8].

Checklist

• It should split a string using a string pattern or a RegExp if the input's a string
• Documentation

Currently, as curry checks the number of passed parameters against the function's length property, curried functions can not have optional parameters, which can be frustrating at times.

Ideas

• use curryN to define the minimum number of required parameters to make the function work. Execute the function as soon as that number has been reached
• parse the toString() representation of the function to see how many optional parameters there are

Warning

• additional parameters should only be the last parameters of a function
• make sure additional parameters are not removed when using the non-curried version

const add = (a, b, c = 3)
curry(add)(1, 2) // should be 6
curry(add)(1, 2, 4) // should be 7

Make sure the code coverage remains the same while adding new code

Checklist

• It should work on all collection types
• It should be tested
• It should be documented

Description
Document all methods on GitBook

Checklist

• always
• apply
• arity
• branch
• capitalize
• compose
• curry
• curryN
• delay
• dump
• entries
• filter
• findIndex
• flip
• forEach
• get
• head
• identity
• ifElse
• into
• isPromise
• iterate
• keys
• map
• next
• pluck
• prepend
• random
• reduce
• replace
• slice
• some
• then
• toLowerCase
• transduce
• transformers
  • filter
  • map
• type
• upsert
• values

Checklist

• It should work on objects
• It should merge deeply by default
• It should use equals for quality check
• It should work on arrays (warning, this will be super slow because need to check if exist)
  • Use upsert
• Add tests

To do:

• make it work on sets
• make it work on objects
• make it work on maps
• add the ability to pass a value directly (+ explain how to find a function) => objects should be found using equal, not ===
• unskip tests

Title says it all 👍 Beware of import paths in the __tests__ folder

My use case is the following :

// I have two arrays representing two differents entities
// linked with a foreign key: userId
const arrays = [
	[{ userId: 1, item: 'junk' }, { userId: 2, item: 'junk2' }],
	[{ userId: 1, stuff: 'stuff' }, { userId: 2, stuff: 'stuff2' }]
];
// I want to merge these two arrays and their entities by this foreign key
const result = [
  { userId: 1, item: 'junk', stuff: 'stuff' } ,
  { userId: 2, item: 'junk2', stuff: 'stuff2' }
]

It can be implemented using compose, reduce & values but it's cumbersome :

compose(
  values,
  reduce(
    (acc, item) =>
      reduce(
        (innerAcc, innerItem) => ({
          ...innerAcc,
          [innerItem.uid]: {
            ...(innerAcc[innerItem.uid] || {}),
            ...innerItem,
          },
        }),
        acc,
        item,
      ),
    {},
  )
)

An similar issue was opened in ramda. I think it's a common use case.

Checklist

• Decide if replace should accept the value or the key it's trying to replace
• It should work on objects
• It should work on sets
• It should work on maps
• It should work on strings
  • If the index is a number, it should replace the matching character
  • If the index is a character, it should replace all matching occurrences of this character
  • If the index is RegExp, it should replace all the matches from the RegExp
• It should accept a function in place of the index parameter
• Add tests
• Update documentation

Add a take method, equivalent to len => slice(0, len)

• Users should have a clear way to control the execution flow
• Having "duplicate" functions to distinguish parallel vs series is frustrating (eg. mapSeries vs map)
• There are already several functions which implement this logic, use them or make it easier to use their inner concurrency model?

compose(a, b, c) /* c -> b -> a, series */
forEach([a, b, c]) /* a // b // c, parallel */
map([a, b, c]) /* a // b // c, parallel */
reduce([a, b, c]) /* a -> b -> c, series */

• See how others are doing it
  • RxJS
  • Contra
  • promise-fun
  • async