scrape-it-core
The core scraping functionality of scrape-it.
:cloud: Installation
npm install --save scrape-it-core
yarn add scrape-it-core
:clipboard: Example
const scrapeIt = require("scrape-it-core")
const data = scrapeIt(`
<h1 class='heading'>Hello World</h1>
<img src="test.jpg" />
<p>Lorem ipsum dolor sit amet...</p>
<ul>
<li>1</li>
<li>2</li>
<li>3</li>
<li>4</li>
<li>5</li>
<li><i>6</i></li>
</ul>
`, {
title: ".heading"
, desc: "p"
, avatar: {
selector: "img"
, attr: "src"
}
, items: {
listItem: "ul > li"
, data: {
content: {
how: "text"
}
}
}
})
console.log(data)
:question: Get Help
There are few ways to get help:
- Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
- For bug reports and feature requests, open issues. :bug:
- For direct and quick help, you can use Codementor. :rocket:
:memo: Documentation
scrapeItCore($, opts)
The core scraping functionality of scrape-it
.
Scrapes the data in the provided element.
For the format of the selector, please refer to the Selectors section of the Cheerio library
Params
-
Cheerio|String $
: The input element or the HTML as a string.
-
Object opts
: An object containing the scraping information.
If you want to scrape a list, you have to use the listItem
selector:
listItem
(String): The list item selector.data
(Object): The fields to include in the list objects:
<fieldName>
(Object|String): The selector or an object containing:
selector
(String): The selector.convert
(Function): An optional function to change the value.how
(Function|String): A function or function name to access the
value.attr
(String): If provided, the value will be taken based on
the attribute name.trim
(Boolean): If false
, the value will not be trimmed
(default: true
).closest
(String): If provided, returns the first ancestor of
the given element.eq
(Number): If provided, it will select the nth element.texteq
(Number): If provided, it will select the nth direct text child.
Deep text child selection is not possible yet.
Overwrites the how
key.listItem
(Object): An object, keeping the recursive schema of
the listItem
object. This can be used to create nested lists.
Example:
{
articles: {
listItem: ".article"
, data: {
createdAt: {
selector: ".date"
, convert: x => new Date(x)
}
, title: "a.article-title"
, tags: {
listItem: ".tags > span"
}
, content: {
selector: ".article-content"
, how: "html"
}
, traverseOtherNode: {
selector: ".upperNode"
, closest: "div"
, convert: x => x.length
}
}
}
}
If you want to collect specific data from the page, just use the same
schema used for the data
field.
Example:
{
title: ".header h1"
, desc: ".header h2"
, avatar: {
selector: ".header img"
, attr: "src"
}
}
Return
:yum: How to contribute
Have an idea? Found a bug? See how to contribute.
:sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
-
Starring and sharing the projects you like :rocket:
-
—I love books! I will remember you after years if you buy me one. :grin: :book:
-
—You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:
-
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
-
Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6
Thanks! :heart:
:scroll: License
MIT © Ionică Bizău