# es-scrollsearch

> Scroll through all Elasticsearch search results as a single stream

Latest version **1.0.0-alpha1** (published 2016-04-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install es-scrollsearch
pnpm add es-scrollsearch
yarn add es-scrollsearch
bun add es-scrollsearch
```

## 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 | 1.0.0-alpha1 |
| Published | 2016-04-08 |
| First published | 2016-03-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ^4.3.0 |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Court Ewing |
| Maintainers | courtewing |
| Keywords | elasticsearch, search, scroll, request, stream |

## Links

- npm: https://www.npmjs.com/package/es-scrollsearch
- Repository: https://github.com/elastic/es-scroll-stream
- Homepage: https://github.com/elastic/es-scrollsearch#readme
- Issues: https://github.com/elastic/es-scrollsearch/issues
- npm.io page: https://npm.io/package/es-scrollsearch

## Dependencies (4)

- [request](https://npm.io/package/request.md) ^2.70.0
- [highland](https://npm.io/package/highland.md) ^2.7.1
- [JSONStream](https://npm.io/package/JSONStream.md) ^1.1.1
- [streamqueue](https://npm.io/package/streamqueue.md) ^1.1.1

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 1.0.0-alpha1 (latest) — 2016-04-08
- 1.0.0-dev — 2016-03-09

## README

# Elasticsearch Scrolling Search [![Circle CI](https://circleci.com/gh/elastic/es-scrollsearch.svg?style=svg)](https://circleci.com/gh/elastic/es-scrollsearch)

Scroll through all Elasticsearch search results as a single stream

## Requirements

* Node.js >= 4.3.0

## Usage

```js
const streamHits = require('es-scrollstream');

const url = 'http://localhost:9200/logstash-*/_search';
const params = { query: { term: { response: 200 } } };

streamHits(url, params).pipe(someOtherStream);
```

## Installation

Install into your project via npm:

```
npm install es-scrollstream --save
```

## Testing

Either run tests as a once off:

```
npm test
```

Or continuously re-run tests whenever files change:

```
npm run test:dev
```

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