# federated-search

> Federated search for abstract-searcher

Latest version **1.1.1** (published 2015-09-29) · BSD-2-Clause license · 0 weekly downloads

## Install

```sh
npm install federated-search
pnpm add federated-search
yarn add federated-search
bun add federated-search
```

## 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.1.1 |
| Published | 2015-09-29 |
| First published | 2015-09-24 |
| Weekly downloads | 0 |
| License | BSD-2-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Karissa McKelvey |
| Maintainers | karissa |

## Links

- npm: https://www.npmjs.com/package/federated-search
- Repository: https://github.com/karissa/node-federated-search
- Homepage: https://github.com/karissa/node-federated-search#readme
- Issues: https://github.com/karissa/node-federated-search/issues
- npm.io page: https://npm.io/package/federated-search

## Dependencies (4)

- [through2](https://npm.io/package/through2.md) ^2.0.0
- [multistream](https://npm.io/package/multistream.md) ^2.0.2
- [run-parallel](https://npm.io/package/run-parallel.md) ^1.1.4
- [parallel-multistream](https://npm.io/package/parallel-multistream.md) ^1.0.1

## Recent versions

- 1.1.1 (latest) — 2015-09-29
- 1.1.0 — 2015-09-29
- 1.0.5 — 2015-09-29
- 1.0.4 — 2015-09-25
- 1.0.3 — 2015-09-24
- 1.0.2 — 2015-09-24
- 1.0.0 — 2015-09-24

## README

# node-federated-search

Federated search for Node.js. This tool assumes you have assembled node modules that implement the [abstract-search](http://github.com/karissa/abstract-search) api.

```
npm install federated-search
```

## Example

```js
var fedsearch = require('federated-search')

var query = {
  field1: 'hello',
  field2: 'world'
}

var searchers = [
  require('ckan-searcher')('www.datahub.io'),
  require('github-searcher')('www.github.com'),
  require('figshare-searcher')('www.figshare.com')
]
```

Use the streaming API.

```js
var stream = fedsearch(query, searchers)
stream.on('data', function (result) {
  console.log(result)
})
stream.destroy() // will stop fetching data.
```

Prints (one for each calback)

```json
{
  "searcher": {"name": "ckan", "url": "www.datahub.io", "version": "latest"},
  "data": data...
}
```

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