# scipio
> A small web scraper
Latest version **0.0.2** (published 2014-06-05) · MIT license · 0 weekly downloads
## Install
```sh
npm install scipio
pnpm add scipio
yarn add scipio
bun add scipio
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.0.2 |
| Published | 2014-06-05 |
| First published | 2014-06-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | alexjab |
| Maintainers | alexjab |
| Keywords | scraper |
## Links
- npm: https://www.npmjs.com/package/scipio
- Repository: https://github.com/alexjab/scipio
- Issues: https://github.com/alexjab/scipio/issues
- npm.io page: https://npm.io/package/scipio
## Dependencies (2)
- [cheerio](https://npm.io/package/cheerio.md) ~0.16.0
- [request](https://npm.io/package/request.md) ~2.36.0
## Alternatives
- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads
## Recent versions
- 0.0.2 (latest) — 2014-06-05
- 0.0.1 — 2014-06-05
## README
Scipio
======
[](http://badge.fury.io/js/scipio)
A small web scraper
Scipio uses [request](https://github.com/mikeal/request) and [cheerio](https://github.com/cheeriojs/cheerio) to retrieve pages and parse them.
License: MIT.
##Example
```
var Scipio = require ('scipio');
var scipio = new Scipio ();
scipio.get ('http://example.org', function ($, body) {
// $ is a jQuery selector
console.log ($ ('p').text ());
});
```
##Usage
###.fromBody (body, callback)
Get a $ selector from a body.
```
scipio.fromBody ('It works!
', function ($) {
console.log ($ ('h1').text ());
});
```
Callback takes `($, body)` as parameters.
###.fromUrl (url, callback)
Get a $ selector from a URL.
```
scipio.fromUrl ('http://example.org', function ($) {
console.log ($ ('p').text ());
});
```
Callback takes `($, body)` as parameters.
Alias: `.get (url, callback)`
###.use (function)
Use a function instead of the default parser.
The parser receives `(error, response, body)` as parameters, and must return an array of parameters for the callback of the `.fromUrl` method.
The default parser returns [$, body, response].
```
scipio.use (function (error, response, body) {
return ['foo', 'bar', 'baz', body];
});
scipio.fromUrl ('http://example.org', function (foo, bar, baz, body) {
console.log (arguments[0], arguments[1], arguments[2]);
//=> foo bar baz
});
```
The parser function must always return an array of values as [line 30 of index.js](https://github.com/alexjab/scipio/blob/master/index.js#L30) shows:
```
callback.apply (this, this._parser (error, body, response));
```
###.setHeaders (key, value)
Set the headers to the specified parameter.
- if the function receives two parameters, the couple `key/value` will be added to the headers,
- if the function receives only one parameter, the headers will be set to it.
```
scipio.setHeaders ('User-Agent', 'My Awesome UserAgent');
// => sets the headers 'User-Agent' property to 'My Awesome UserAgent'
scipio.setHeaders ({'User-Agent': 'My Awesome UserAgent'});
// => sets the headers to {'User-Agent': 'My Awesome UserAgent'}
```
##Testing
```
make test
```
##License
MIT
The MIT License (MIT)
Copyright (c) 2014 Alexandre Jablon
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
---
_Source: https://npm.io/package/scipio · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._