# flumeview-links

> flume view for tracking "links", based on flumeview-level

Latest version **2.1.0** (published 2020-07-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install flumeview-links
pnpm add flumeview-links
yarn add flumeview-links
bun add flumeview-links
```

## 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.1.0 |
| Published | 2020-07-05 |
| First published | 2020-05-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 10.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Dominic Tarr |
| Maintainers | christianbundy, mixmix, staltz |
| Keywords | flumedb, view |

## Links

- npm: https://www.npmjs.com/package/flumeview-links
- Repository: https://github.com/flumedb/flumeview-links
- Homepage: https://github.com/flumedb/flumeview-links#readme
- Issues: https://github.com/flumedb/flumeview-links/issues
- npm.io page: https://npm.io/package/flumeview-links

## Dependencies (5)

- [deep-equal](https://npm.io/package/deep-equal.md) ^2.0.3
- [pull-stream](https://npm.io/package/pull-stream.md) ^3.6.14
- [pull-flatmap](https://npm.io/package/pull-flatmap.md) 0.0.1
- [flumeview-level](https://npm.io/package/flumeview-level.md) ^4.0.3
- [map-filter-reduce](https://npm.io/package/map-filter-reduce.md) ^3.2.2

## Recent versions

- 2.1.0 (latest) — 2020-07-05
- 2.0.1 — 2020-06-15
- 2.0.0 — 2020-06-10
- 1.0.1 — 2020-05-22
- 1.0.0 — 2020-05-22

## README

# flumeview-links

> This is `links.js` from `flumeview-query@6.2.0`

TODO ... more detail


## API

### flumedb.use("links", FlumeViewLinks(indexes, links, version))

`indexes` to use. `links` is an optional function used for mapping a
value into one or more values for the index. `version` must be an
number. When you change `indexes` or `links`, bump the version and the
index will rebuild.

Here we use the name "links", you can use any name.

### flumedb.links.read({query: MFR_query, limit, reverse, live, old, unlinkedValues}) => source

Perform the query! limit, reverse, live, old are stardard as with
other flume streams. `unlinkedValues` is an option that can be used to
include the values not part of the index in the return value.

### flumedb.links.explain({query: MFR_query, limit, reverse, live, old, unlinkedValues}, cb)

Right now only calls back with `{ index }` - the index your example query would use (if any)

## License

MIT

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