# searchscout

Latest version **1.0.5** (published 2021-11-13) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install searchscout
pnpm add searchscout
yarn add searchscout
bun add searchscout
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2021-11-13 |
| First published | 2021-08-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 603.6 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | frederic2ec <freddy.cho@hotmail.com> |
| Maintainers | frederic2ec |

## Links

- npm: https://www.npmjs.com/package/searchscout
- Repository: git@github.com:frederic2ec/scout.git
- npm.io page: https://npm.io/package/searchscout

## Dependencies (4)

- [axios](https://npm.io/package/axios.md) ^0.24.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [xml-js](https://npm.io/package/xml-js.md) ^1.6.11
- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.10

## Recent versions

- 1.0.5 (latest) — 2021-11-13
- 1.0.4 — 2021-10-25
- 1.0.3 — 2021-10-11
- 1.0.2 — 2021-08-09
- 1.0.1 — 2021-08-05
- 1.0.0 — 2021-08-05

## README

# Scout
### Fast and easy search engine scrapper powering [Meerkt](https://www.meerkt.com).

---
1. [Features](#features)
2. [How to install](#how-to-install)
3. [Basic example](#basic-example)
4. [Autocomplete example](#autocomplete-example)

## Features

- 🚀 Fast and easy to use !
- ✨ Support for multiples search engines (Google, Bing, DuckDuckGo, Qwant, Yahoo, Wikipedia)
- ✅ Safety checks and errors handling
- 🛠 Written in typescript and promise based
- 🍑 Safe search and adult content filtering support


## How to install
``>> npm install --save searchscout``

``>> yarn add searchscout``

## Basic example
```javascript
const Scout = require('searchscout');

(async () => {
    // new Scout('query', page (optional), Safesearch (optional), Language (optional))
    const scout = new Scout('node.js documentation', 1, SafeSearch.None, Language["en-US"])

    const results = await scout.search(); // Return an Results types

    console.log(results)
})();
```

## Autocomplete example
```javascript
const Scout = require('searchscout');

(async () => {
    // new Scout('query')
    const scout = new Scout('node.js documentation')

    const results = await scout.autocomplete() // Return an array of string

    console.log(results)
})();
```

## Support & Pulls request
- If you have any questions or request, please do so by opening an issue on the github.
- If you want to contribute or fix issues, please do so by opening a pull request

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