Gathering detailed insights and metrics for cheerio
Gathering detailed insights and metrics for cheerio
Gathering detailed insights and metrics for cheerio
Gathering detailed insights and metrics for cheerio
The fast, flexible, and elegant library for parsing and manipulating HTML and XML.
npm install cheerio
Module System
Min. Node Version
Typescript Support
Node Version
NPM Version
28,736 Stars
3,419 Commits
1,640 Forks
357 Watching
12 Branches
135 Contributors
Updated on 28 Nov 2024
TypeScript (74.26%)
HTML (23.96%)
JavaScript (1.25%)
CSS (0.43%)
MDX (0.09%)
Cumulative downloads
Total Downloads
Last day
0.1%
1,920,124
Compared to previous day
Last week
5.2%
10,355,012
Compared to previous week
Last month
14.1%
41,443,293
Compared to previous month
Last year
9.1%
413,247,987
Compared to previous year
11
26
1import * as cheerio from 'cheerio'; 2const $ = cheerio.load('<h2 class="title">Hello world</h2>'); 3 4$('h2.title').text('Hello there!'); 5$('h2').addClass('welcome'); 6 7$.html(); 8//=> <html><head></head><body><h2 class="title welcome">Hello there!</h2></body></html>
npm install cheerio
❤ Proven syntax: Cheerio implements a subset of core jQuery. Cheerio removes all the DOM inconsistencies and browser cruft from the jQuery library, revealing its truly gorgeous API.
ϟ Blazingly fast: Cheerio works with a very simple, consistent DOM model. As a result parsing, manipulating, and rendering are incredibly efficient.
❁ Incredibly flexible: Cheerio wraps around parse5 for parsing HTML and can optionally use the forgiving htmlparser2. Cheerio can parse nearly any HTML or XML document. Cheerio works in both browser and server environments.
First you need to load in the HTML. This step in jQuery is implicit, since jQuery operates on the one, baked-in DOM. With Cheerio, we need to pass in the HTML document.
1// ESM or TypeScript: 2import * as cheerio from 'cheerio'; 3 4// In other environments: 5const cheerio = require('cheerio'); 6 7const $ = cheerio.load('<ul id="fruits">...</ul>'); 8 9$.html(); 10//=> <html><head></head><body><ul id="fruits">...</ul></body></html>
Once you've loaded the HTML, you can use jQuery-style selectors to find elements within the document.
selector
searches within the context
scope which searches within the root
scope. selector
and context
can be a string expression, DOM Element, array
of DOM elements, or cheerio object. root
, if provided, is typically the HTML
document string.
This selector method is the starting point for traversing and manipulating the document. Like in jQuery, it's the primary method for selecting elements in the document.
1$('.apple', '#fruits').text(); 2//=> Apple 3 4$('ul .pear').attr('class'); 5//=> pear 6 7$('li[class=orange]').html(); 8//=> Orange
When you're ready to render the document, you can call the html
method on the
"root" selection:
1$.root().html(); 2//=> <html> 3// <head></head> 4// <body> 5// <ul id="fruits"> 6// <li class="apple">Apple</li> 7// <li class="orange">Orange</li> 8// <li class="pear">Pear</li> 9// </ul> 10// </body> 11// </html>
If you want to render the
outerHTML
of a selection, you can use the outerHTML
prop:
1$('.pear').prop('outerHTML'); 2//=> <li class="pear">Pear</li>
You may also render the text content of a Cheerio object using the text
method:
1const $ = cheerio.load('This is <em>content</em>.'); 2$('body').text(); 3//=> This is content.
Cheerio collections are made up of objects that bear some resemblance to browser-based DOM nodes. You can expect them to define the following properties:
tagName
parentNode
previousSibling
nextSibling
nodeValue
firstChild
childNodes
lastChild
This video tutorial is a follow-up to Nettut's "How to Scrape Web Pages with Node.js and jQuery", using cheerio instead of JSDOM + jQuery. This video shows how easy it is to use cheerio and how much faster cheerio is than JSDOM + jQuery.
Are you using cheerio in production? Add it to the wiki!
Does your company use Cheerio in production? Please consider sponsoring this project! Your help will allow maintainers to dedicate more time and resources to its development and support.
Headlining Sponsors
Other Sponsors
Become a backer to show your support for Cheerio and help us maintain and improve this open source project.
MIT
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
30 commit(s) and 3 issue activity found in the last 90 days -- score normalized to 10
Reason
security policy file detected
Details
Reason
license file detected
Details
Reason
SAST tool is run on all commits
Details
Reason
3 existing vulnerabilities detected
Details
Reason
dependency not pinned by hash detected -- score normalized to 5
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
project is not fuzzed
Details
Score
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More