fluent-curry - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "fluent-curry",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "author": "Will Martin (https://willmartian.com)",
@@ -5,0 +5,0 @@ "repository": {

README.md

@@ -5,4 +5,6 @@ # fluent-curry
 
-## Examples 
+## Example: Options object
 
+For functions that take a single object parameter, the type of the curried result is infered from the object parameter type.
+
 ```ts
@@ -19,4 +21,25 @@ import { fluentCurry } from "fluent-curry";
 
-// Partial Applications
+```
 
+## 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.
+
+```ts
+const adLib = (name: string, age: number) => {
+  return `${name} is ${age}.`;
+};
+
+const curried = fluentCurry(adLib, ['name', 'age']);
+
+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.
+
+```ts
+
 const partialWill = curried.name('Will');
@@ -26,2 +49,8 @@
 
+```
+
+Any parameters that have not been previously applied can be supplied in the `call` function as an options object.
+
+```ts
+
 // Call with Parameters
@@ -47,8 +76,8 @@
 
-While terse, using positional arguments sacrifices readability. Furthemore, this syntax tends to trip up programmers with less functional programming experience.
+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 rely on some sort of special skip value:
+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:
 
 ```ts
-import { _ } from 'some-curry-library';
+import { _ } from 'some-other-curry-library';
 
@@ -58,2 +87,16 @@ 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.
+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.
+
+```ts
+
+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();
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4953

increased by29.73%

Number of lines in readme file

97

increased by79.63%

No dependency changes