Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

curry-map

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

curry-map

Currying with pathways

  • 0.1.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
6
increased by500%
Maintainers
1
Weekly downloads
 
Created
Source

CurryMap

Currying with pathways

Install the module from npm

npm i curry-map --save

How do I use this library?

Brace yourself. Not for the faint fo heart.

Okay maybe I'm exaggerating a bit, but it looks complicated bear with me. Currying is the ability to pass parameters to a function all at once or one at a time.

// all equivalent
aCurriedFunc('my-arg-1', 'my-arg-2', 'my-arg-3');
aCurriedFunc('my-arg-1')('my-arg-2')('my-arg-3');
aCurriedFunc('my-arg-1')('my-arg-2', 'my-arg-3');
aCurriedFunc('my-arg-1', 'my-arg-2')('my-arg-3');

What if a different function were run depending on which arguments were passed, that is the goal of this library.

Building a CurryMap

Your only task at this moment as a developer is to build a CurryMap. Each argument takes you closer to a end result but at which end result will you arrive?

const CurryMap = require('curry-map');

const paths = {
    batman: CurryMap({
        batarang: () => 'shwiiiing',
        parents: () => '...'
    }),
    joker: CurryMap({
        laugh: () => 'HaHAhahA',
        do_taxes: () => 'HAhaHAHAHa'
    })
};

const myApi = CurryMap(paths)();

myApi('joker', 'laugh');
#=> HaHAhahA

Note: One single () follows only the primary definition.

Capturing input

The first parameter of CurryMap is always an object containing api endpoints. An optional second parameter indicates any other input should it not be in the arguments list, for example a document id or database name should you need them. Things start to get complicated here be vigilant.

const capts = CurryMap({
    say_hi: (name) => 'Hi ' + name + '!',
    say_goodbye: (name) => 'Goodbye ' + name + '! :('
});

const mySecondApi = CurryMap(paths, capts)();

mySecondApi('batman', 'batarang');
mySecondApi('Keith', 'say_hi');
#=> shwiiiing
#=> Hi Keith!

Any function-type second parameter captures input, you can do this many times.

const ageify = (name, age) => name + ' is ' + age;

const myThirdApi = CurryMap({}, CurryMap({}, ageify))();

myThirdApi('Becca', 31);
#=> Becca is 31

Capture helper

The following is equivalent to above.

const myFourthApi = CurryMap.deep(2, ageify)();

myFourthApi('Becca', 31);
#=> Becca is 31

You can also keep things going if you want to with another CurryMap.

const myFifthApi = CurryMap.deep(2, CurryMap({ run: ageify }))();

myFifthApi('Ruddiger', 112, 'run');
#=> Ruddiger is 112

Extending the prototype

Prototype extensions are passed with either the second or third parameter. Its attributes are always functions which accept the curry up to that point, followed by what you want to return.

const mySixthApi = CurryMap({
    superman: CurryMap({
        fly: () => 'Swoooosh',
        turn_back_time: () => 'Swoooooooooooosh',
        arms: CurryMap({
            punch: () => 'WHAMMO'
        })
    }, CurryMap({}, {
        threaten: (who) => (words) => 'Forsooth ' + who + '! ' + words,
        address: (who) => (words) => 'Dearest ' + who + '. ' + words
    }))
})();

mySixthApi('superman', 'bad guy').threaten('You are out of time.');
mySixthApi('superman', 'arms', 'punch');
mySixthApi('superman', 'citizens').address('Celebrate!');
#=> Forsooth bad guy! You are out of time.
#=> WHAMMO
#=> Dearest citizens. Celebrate!

General considerations

A CurryMap is a function accepting (...curry) as its parameters, it returns a function with optional prototype extensions whch when run traverses further.

When you compile a complex CurryMap it's going to look like a big huge mess. I'm not sure what to tell you about how to fix that. Some kind of extreme discipline is probably required in order to keep it looking sane and manageable, or if you have a robot eye you may be able to understand all of the paths.

Contribute

If you like what you see please feel encouraged to get involved report problems and submit pull requests! As of the time of this writing the project is new with one maintainer.

Keywords

FAQs

Package last updated on 26 Feb 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc