Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/knpwrs/pass-context

Higher-order function to create a function which receives its context as its first argument.
https://github.com/knpwrs/pass-context

Last synced: 1 day ago
JSON representation

Higher-order function to create a function which receives its context as its first argument.

Awesome Lists containing this project

README

        

# pass-context

[![Greenkeeper badge](https://badges.greenkeeper.io/knpwrs/pass-context.svg)](https://greenkeeper.io/)

> Higher-order function to create a function which receives its context as its
> first argument.

## What?

Sometimes you want to use arrow functions with an API that was designed with
context (`this`) in mind. This is a small library which will pass a function's
execution context as that function's first argument. The arguments which are passed to the function are passed in addition to the context argument.

## Installation

### npm

```
npm i -S pass-context
```

The library function is the default export of the package.

### CDN (UMD)

```
https://unpkg.com/[email protected]/dist/pass-context.min.js
```

The library function is exported as `passContext`.

## Usage

```js
import pc from 'pass-context';
const input = document.querySelector('.my-fancy-input');
input.addEventListener('change', pc((ctx, event) => {
// `ctx` is what is normally accessible with `this` as if a normal function were passed as the event listener.
// `event` (and any additional arguments) are the normal arguments passed in-order after the context argument.
// Since this is an arrow function, `this` is inherited.
}));
```

### Detailed Usage Example

```js
import pc from 'pass-context';
const fn = pc(({ foo }, bar) => foo + bar);
console.log(fn.call({ foo: 'Hello, '}, 'World!')); // Logs "Hello, World!"
```

## License

**MIT**