# pull-cursor

> A pull-stream over series that have an index.

Latest version **3.0.0** (published 2018-05-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install pull-cursor
pnpm add pull-cursor
yarn add pull-cursor
bun add pull-cursor
```

## 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 | 3.0.0 |
| Published | 2018-05-30 |
| First published | 2017-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 12.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | 'Dominic Tarr' |
| Maintainers | arj03, dominictarr |

## Links

- npm: https://www.npmjs.com/package/pull-cursor
- Repository: https://github.com/dominictarr/pull-cursor
- Issues: https://github.com/dominictarr/pull-cursor/issues
- npm.io page: https://npm.io/package/pull-cursor

## Dependencies (3)

- [ltgt](https://npm.io/package/ltgt.md) ^2.2.0
- [looper](https://npm.io/package/looper.md) ^4.0.0
- [pull-stream](https://npm.io/package/pull-stream.md) ^3.6.0

## Recent versions

- 3.0.0 (latest) — 2018-05-30
- 2.1.3 — 2017-06-22
- 2.1.2 — 2017-05-18
- 2.1.0 — 2017-05-18
- 2.0.0 — 2017-05-18
- 1.0.1 — 2017-05-17
- 1.0.0 — 2017-05-17

## README

# pull-cursor

A pull-stream over series that have an index.

I wrote this to abstract out streams for [flumelog-offset](https://github.com/flumedb/flumelog-offset)
it makes flexible streams on ranges easy, including live streams!

## api

``` js
var inject = require('pull-cursor')
```

### inject(since, getMeta) => createStream(opts)

`since` is an `obv` instance, which represents the current length of
the dataset. `getMeta` is a function that takes an offset, an option
to use caching and callback the value plus the `next` and `prev`
offsets.

``` js
var Obv = require('obv')
var since = Obv()

//dummy example with an array as the datastore
var ary = ['A', 'B', 'C', 'D']
since.set(ary.length - 1) //set since to last index!

var createStream = require('pull-cursor')(
  since,
  function (offset, useCache, cb) {
    if(offset < 0 || offset >= ary.length)
      return cb(new Error('out of bounds:'+offset)

    cb(null, ary[offset], offset-1, offset+1)

  })
```

### createStream(opts) => Source

`createStream` now accepts all the typical options of a
levelup or flumedb stream. including
* `reverse` (boolean) read backwards
* `live` (boolean) include new items
* `old` (boolean) include old items (set to false implies `live`)
* `gt` (offset) items greater than a valid offset
* `gte` (offset) items greater or equal to a valid offset
* `lt` (offset) items less than a given offset
* `lte` (offset) items less than or equal to a given offset
* `limit` (number) stop after N items.
* `cache` (boolean) use cache of underlying

## License

MIT

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