# to-function

> Convert property access strings into functions

Latest version **2.0.6** (published 2015-01-30) · 0 weekly downloads

## Install

```sh
npm install to-function
pnpm add to-function
yarn add to-function
bun add to-function
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.6 |
| Published | 2015-01-30 |
| First published | 2012-09-20 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 63 |
| Maintainers | tjholowaychuk, mattmueller, timoxley, jonathanong, jongleberry, tootallnate, clintwood, thehydroimpulse, stephenmathieson, trevorgerhardt, timaschew, hughsk |
| Keywords | utility |

## Links

- npm: https://www.npmjs.com/package/to-function
- Repository: https://github.com/component/to-function
- Issues: https://github.com/component/to-function/issues
- npm.io page: https://npm.io/package/to-function

## Dependencies (1)

- [component-props](https://npm.io/package/component-props.md) *

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 2.0.6 (latest) — 2015-01-30
- 2.0.5 — 2014-05-28
- 2.0.4 — 2014-05-20
- 2.0.3 — 2014-04-04
- 2.0.1 — 2014-03-26
- 2.0.0 — 2014-03-26
- 1.2.1 — 2014-02-12
- 1.2.0 — 2012-12-16
- 1.1.1 — 2012-11-21
- 1.1.0 — 2012-11-21
- 1.0.0 — 2012-11-09
- 0.0.1 — 2012-09-20

## README

# to-function

  Convert property access strings into functions

## Installation

    $ component install component/to-function

## Examples

```js
var toFunction = require('to-function');
var fn = toFunction('name.first');
var user = { name: { first: 'Tobi' }};
fn(user);
// => "Tobi"
```

### Dot access

```js

var _ = require('..');

var users = [
  { name: { first: 'Tobi' }},
  { name: { first: 'Loki' }},
  { name: { first: 'Jane' }},
  { name: { first: 'Manny' }}
];

var short = users.map(_('name.first'));
console.log(short);
// => [ 'Tobi', 'Loki', 'Jane', 'Manny' ]
```

### Equality

```js
var _ = require('..');

var tobi = { name: { first: 'Tobi' }, age: 2 };
var loki = { name: { first: 'Loki' }, age: 2 };
var jane = { name: { first: 'Jane' }, age: 6 };

var users = [tobi, loki, jane];

var user = users.filter(_(loki)).pop();
console.log(user);
// => { name: { first: 'Loki' }, age: 2 }
```

### Expressions

```js
var _ = require('..');

var users = [
  { name: { first: 'Tobi' }, age: 2 },
  { name: { first: 'Loki' }, age: 2 },
  { name: { first: 'Jane' }, age: 6 }
];

var oldPets = users.filter(_('age > 2 && age < 10'));
console.log(oldPets);
// => [ { name: { first: 'Jane' }, age: 6 } ]
```

### Regular expressions

```js
var _ = require('..');

var users = [
  'Tobi',
  'Loki',
  'Jane'
];

var t = users.filter(_(/^T/));

console.log(t);
// => [ 'Tobi' ]
```

### Nesting

```js
var _ = require('..');

var users = [
  { name: { first: 'Tobi', last: 'Ferret' }, age: 2 },
  { name: { first: 'Loki', last: 'Ferret' }, age: 2 },
  { name: { first: 'Luna', last: 'Cat' }, age: 2 },
  { name: { first: 'Manny', last: 'Cat' }, age: 3 }
];

// single-key

var query = _({
  name: {
    last: 'Cat'
  }
});

console.log(users.filter(query));
// => [ { name: { first: 'Luna', last: 'Cat' }, age: 2 },
//      { name: { first: 'Manny', last: 'Cat' }, age: 3 } ]

// multi-key

var query = _({
  name: {
    first: /^L/,
    last: 'Cat'
  }
});

console.log(users.filter(query));
// => [ { name: { first: 'Luna', last: 'Cat' }, age: 2 } ]

// multi-level

var query = _({
  name: { last: 'Cat' },
  age: 3
});

console.log(users.filter(query));
// => [ { name: { first: 'Manny', last: 'Cat' }, age: 3 } ]
```

## License

  MIT

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