Git Product home page Git Product logo

fluent-curry's Introduction

fluent-curry

npm bundlephobia

Curry functions using a type-safe fluent API.

curried.name('Will').age(25).call()

Example: Multiple paramters

For functions that take multiple parameters, we must supply an array of paramter names in the same order that they appear in the function signature.

const adLib = (name: string, age: number) => {
  return `${name} is ${age}.`;
};

const curried = fluentCurry(adLib, ['name', 'age']);

curried.name('Will').age(25).call() === adLib('Will', 25);

Example: Options object

For functions that take a single object parameter, the type of the curried result is infered from the object parameter type.

import { fluentCurry } from "fluent-curry";

const adLib = (args: { name: string; age: number; }) => {
  return `${args.name} is ${args.age}.`;
};

const curried = fluentCurry(adLib);

curried.name('Will').age(25).call() === adLib({ name: 'Will', age: 25 });

Partial Applications

fluent-curry makes working with partial applications easy. Create reusable logic without a cumbersome bind method.

const partialWill = curried.name('Will');

partialWill.age(25).call() === adLib({ name: 'Will', age: 25 });

Any parameters that have not been previously applied can be supplied in the call function as an options object.

// Call with Parameters

partialWill.call({ age: 25 }) === adLib({ name: 'Will', age: 25 });

curried.call({ name: 'Will', age: 25 }) === adLib({ name: 'Will', age: 25 });

Why?

Currying and partial applications are two powerful patterns in functional programming. However, the traditional approach to currying has poor syntax.

const func = (a, b, c) => {}
const curried = curry(func);

curried('foo')('bar')('foobar');

While terse, using positional arguments sacrifices readability. Furthermore, this syntax tends to trip up programmers with less functional programming experience.

Traditional currying also makes it difficult to skip over optional arguments or create partial applications--usually, libraries will rely on some sort of special skip value:

import { _ } from 'some-other-curry-library';

const partialBar = curried(_)('bar')(_);

While the approach taken by fluent-curry definitely requires more typing, it is always clear to the developer what argument is being passed. Arguments can also occur in any order, and can be easily left off to create partial applications.

const curried = fluentCurry((a: number, b: number, c: number) => {
  return a + b + c;
}, ['a', 'b', 'c'])

const abc = curried.a(1).b(2).c(3).call();
const bca = curried.b(2).c(3).a(1).call();
const cba = curried.c(3).b(2).a(1).call();
const ab = curried.a(1).b(2);

abc === bca === cba === ab.c(3).call();

fluent-curry's People

Contributors

willmartian avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

dr-zhuim

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.