# array-map-sorted

> Compare two sorted arrays, and map the items of the first map to matched ones.

Latest version **1.3.1** (published 2017-11-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install array-map-sorted
pnpm add array-map-sorted
yarn add array-map-sorted
bun add array-map-sorted
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.1 |
| Published | 2017-11-30 |
| First published | 2017-09-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=4 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | kaelzhang |
| Maintainers | kael |
| Keywords | array-map-sorted, array, match, compare |

## Links

- npm: https://www.npmjs.com/package/array-map-sorted
- Repository: https://github.com/kaelzhang/node-array-map-sorted
- Homepage: https://github.com/kaelzhang/node-array-map-sorted#readme
- Issues: https://github.com/kaelzhang/node-array-map-sorted/issues
- npm.io page: https://npm.io/package/array-map-sorted

## Recent versions

- 1.3.1 (latest) — 2017-11-30
- 1.3.0 — 2017-11-28
- 1.2.1 — 2017-11-27
- 1.2.0 — 2017-09-19
- 1.1.0 — 2017-09-19
- 1.0.0 — 2017-09-19

## README

[![Build Status](https://travis-ci.org/kaelzhang/node-array-map-sorted.svg?branch=master)](https://travis-ci.org/kaelzhang/node-array-map-sorted)
[![Coverage](https://codecov.io/gh/kaelzhang/node-array-map-sorted/branch/master/graph/badge.svg)](https://codecov.io/gh/kaelzhang/node-array-map-sorted)
<!-- optional appveyor tst
[![Windows Build Status](https://ci.appveyor.com/api/projects/status/github/kaelzhang/node-array-map-sorted?branch=master&svg=true)](https://ci.appveyor.com/project/kaelzhang/node-array-map-sorted)
-->
<!-- optional npm version
[![NPM version](https://badge.fury.io/js/array-map-sorted.svg)](http://badge.fury.io/js/array-map-sorted)
-->
<!-- optional npm downloads
[![npm module downloads per month](http://img.shields.io/npm/dm/array-map-sorted.svg)](https://www.npmjs.org/package/array-map-sorted)
-->
<!-- optional dependency status
[![Dependency Status](https://david-dm.org/kaelzhang/node-array-map-sorted.svg)](https://david-dm.org/kaelzhang/node-array-map-sorted)
-->

# array-map-sorted

Compare two sorted arrays, and map the items of the first map to matched ones.

## Install

```sh
$ npm install array-map-sorted
```

## Usage

```js
import map from 'array-map-sorted'

const args = [
  [
    // 1 matches 4
    1,
    // 2 starts to match from 5 (4 has already been matched), and no matches
    2,
    // 3 starts to match from 5, and matches 9
    3
  ],
  [4, 5, 7, 9],
  (a, b) => b % a === 0
]

map(...args)
// [4, undefined, 9]

map(...args, 0)
// [4, 0, 9]

map(...args, 0, (datum, rel) => datum + rel)
// [5, 0, 12]
```

## map(data, relative, matcher, defaultValue = undefined, mapper)

- **data** `Array<datum>` the array to be mapped
- **relative** `Array<rel>` which each datum of `data` will be matched with.
- **matcher** `function(datum, rel, datum_i, rel_i): boolean` the matcher function
- **defaultValue** `any=undefined` if there is no match, the datum will be mapped to `defaultValue`
- **mapper** `function(datum, rel, datum_i, rel_i): any` if there is a match, `mapper` returns the value which the datum to be mapped into. By default, `mapper` is `(datum, rel) => rel`.

Returns `Array`

## License

MIT

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