# curry-method

> A lightweight module that helps you curry any methods and use them in a pipe.

Latest version **0.2.0** (published 2020-09-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install curry-method
pnpm add curry-method
yarn add curry-method
bun add curry-method
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2020-09-06 |
| First published | 2020-09-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 33.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Hugo Sum |
| Maintainers | johnwinston0410 |
| Keywords | Ramda, functional, programming, pipe, method piping |

## Links

- npm: https://www.npmjs.com/package/curry-method
- npm.io page: https://npm.io/package/curry-method

## Dependencies (1)

- [ramda](https://npm.io/package/ramda.md) ^0.27.1

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 0.2.0 (latest) — 2020-09-06
- 0.1.1 — 2020-09-06
- 0.1.0 — 2020-09-05

## README

# curryMethod.js

[![Maintainability](https://api.codeclimate.com/v1/badges/0d8faad59fcaa2f3ffaf/maintainability)](https://codeclimate.com/github/winston0410/method-plumber.js/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/0d8faad59fcaa2f3ffaf/test_coverage)](https://codeclimate.com/github/winston0410/method-plumber.js/test_coverage) [![Known Vulnerabilities](https://snyk.io/test/github/winston0410/method-plumber.js/badge.svg?targetFile=package.json)](https://snyk.io/test/github/winston0410/method-plumber.js?targetFile=package.json) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/8680d880cabd4a4fba62d086c2f0ab95)](https://www.codacy.com/manual/winston0410/method-plumber.js?utm_source=github.com&utm_medium=referral&utm_content=winston0410/method-plumber.js&utm_campaign=Badge_Grade)

A lightweight module that helps you curry any methods and use them in a pipe and function composition.

```javascript
//Curry element.classList.add()
const addClass = curryMethod(1, 'classList.add')
const removeClass = curryMethod(1)('classList.remove')

const element = document.getElementById('test-id')

//Both would work, just like those curried functions provided by Ramda
addClass('first-class')(element)
removeClass('second-class', element)
//These functions is identical with element.classList.add('first-class')
```

## Why do you want to curry methods?

By currying methods, you can easily create partial functions, make it work in a pipe and reuse your code to a greater extent.

## Installation

With npm:

```bash
npm i curry-method
```

Or via CDN:

```html
<script defer src="https://unpkg.com/browse/curry-method/dist/index.esm.js"></script>

<script defer src="https://unpkg.com/browse/curry-method/dist/index.cjs.js"></script>
```

Or directly include the script in you site:

```html
<script defer src="/path/to/your/dir/index.esm.js"></script>
```

Then in the script where you want to use this library:

```javascript
import {
  curryMethod
} from 'curry-method'
```

## API Reference

### `curryMethod(arity, methodPath)(...args)`

This function will curry a method and turn it into a function.

`arity` : Number

Indicate the number of argument to be received by the methods.

**Note that you should not count the `obj` , which is the final argument in with this number**

`methodPath` : String

Indicate the path to access methods. For example `classList.add` and `setAttribute`.

`...args` : Any

Arguments you want to pass to the curried methods. The number of argument should match with `arity`. The last element should be the object which has the method for you to access.

### `getArg(indice, fn)(...args)(obj)`

This function will make a function return a specific argument, based on the indice.

`indice` : Number

Indicate the position of argument you want the function to return from the array `args`

`methodPath` : String

Indicate the path to access methods. For example `classList.add` and `setAttribute`.

`...args` : Any

Arguments you want to pass to `fn`

---
_Source: https://npm.io/package/curry-method · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._