cheerio
v1.2.0TypeScript
The fast, flexible & elegant library for parsing and manipulating HTML and XML.
0/weekUpdated 2 weeks agoMITUnpacked: 1.0 MB
Published by Matt Mueller
npm install cheeriocheerio
The fast, flexible, and elegant library for parsing and manipulating HTML and XML.
``js
import * as cheerio from 'cheerio';
const $ = cheerio.load('Hello world
');
$('h2.title').text('Hello there!');
$('h2').addClass('welcome');
$.html();
//=>
Hello there!
`
Installation
Install Cheerio using a package manager like npm, yarn, or bun.
bash
npm install cheerio
or
bun add cheerio
`Features
❤ 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.
API
$3
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.
js
// ESM or TypeScript:
import * as cheerio from 'cheerio';// In other environments:
const cheerio = require('cheerio');
const $ = cheerio.load('
...
');$.html();
//=>
...
`$3
Once you've loaded the HTML, you can use jQuery-style selectors to find elements
within the document.
#### \$( selector, [context], [root] )
searches within the context scope which searches within the root
scope. 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.
`js
$('.apple', '#fruits').text();
//=> Apple$('ul .pear').attr('class');
//=> pear
$('li[class=orange]').html();
//=> Orange
`$3
When you're ready to render the document, you can call the
method on the
"root" selection:`js
$.root().html();
//=>
//
//
//
// - Apple
// - Orange
// - Pear
//
//
//
`
of a selection, you can use the prop:`js
$('.pear').prop('outerHTML');
//=> Pear
`You may also render the text content of a Cheerio object using the
method:js
const $ = cheerio.load('This is content.');
$('body').text();
//=> This is content.
`$3
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:
-
-
-
-
-
-
-
- Screencasts
> 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.
Cheerio in the real world
Are you using cheerio in production? Add it to the
wiki!
Sponsors
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
Backers
Become a backer to show your
support for Cheerio and help us maintain and improve this open source project.
License
MIT