Tiny, fast, and elegant implementation of core jQuery designed specifically for the server
Cheerio is a fast, flexible, and lean implementation of core jQuery designed specifically for the server. It allows users to manipulate and traverse HTML documents with a familiar jQuery-like API in a Node.js environment.
HTML Parsing
Cheerio can parse HTML and allows you to select and manipulate HTML elements in a way similar to jQuery.
const cheerio = require('cheerio');
const $ = cheerio.load('<h2 class="title">Hello world</h2>');
$('h2.title').text('Hello there!');
$('h2').addClass('welcome');
console.log($.html());DOM Traversal
Cheerio provides methods to traverse the DOM tree, such as selecting elements by class, id, or tag name.
const cheerio = require('cheerio');
const $ = cheerio.load('<ul id="fruits"><li class="apple">Apple</li><li class="orange">Orange</li></ul>');
$('.apple', '#fruits').text();
$('ul .apple').attr('class');DOM Manipulation
Cheerio allows you to manipulate the DOM by adding, removing, or modifying elements and their attributes.
const cheerio = require('cheerio');
const $ = cheerio.load('<ul id="fruits"></ul>');
$('#fruits').append('<li>Banana</li>');
$('#fruits').prepend('<li>Apple</li>');
$('#fruits').after('<p>Nothing to see here</p>');jsdom is a pure-JavaScript implementation of many web standards, notably the WHATWG DOM and HTML Standards. It is more heavyweight than cheerio as it aims to provide a complete browsing environment, but it is useful for more complex scenarios where a full DOM API is needed.
Puppeteer is a Node library which provides a high-level API to control Chrome or Chromium over the DevTools Protocol. It is different from cheerio as it allows for browser automation, including but not limited to DOM manipulation, and is capable of rendering and screenshotting web pages.
Fast, flexible, and lean implementation of core jQuery designed specifically for the server.
Teach your server HTML.
var cheerio = require('cheerio'),
$ = cheerio.load('<h2 class="title">Hello world</h2>');
$('h2.title').text('Hello there!');
$('h2').addClass('welcome');
$.html();
//=> <h2 class="title welcome">Hello there!</h2>
npm install cheerio
❤ Familiar 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. Preliminary end-to-end benchmarks suggest that cheerio is about 8x faster than JSDOM.
❁ Insanely flexible: Cheerio wraps around @FB55's forgiving htmlparser. Cheerio can parse nearly any HTML or XML document.
I wrote cheerio because I found myself increasingly frustrated with JSDOM. For me, there were three main sticking points that I kept running into again and again:
• JSDOM's built-in parser is too strict: JSDOM's bundled HTML parser cannot handle many popular sites out there today.
• JSDOM is too slow: Parsing big websites with JSDOM has a noticeable delay.
• JSDOM feels too heavy: The goal of JSDOM is to provide an identical DOM environment as what we see in the browser. I never really needed all this, I just wanted a simple, familiar way to do HTML manipulation.
Cheerio will not solve all your problems. I would still use JSDOM if I needed to work in a browser-like environment on the server, particularly if I wanted to automate functional tests.
<ul id="fruits">
<li class="apple">Apple</li>
<li class="orange">Orange</li>
<li class="pear">Pear</li>
</ul>
This is the HTML markup we will be using in all of the API examples.
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.
This is the preferred method:
var cheerio = require('cheerio'),
$ = cheerio.load('<ul id="fruits">...</ul>');
Optionally, you can also load in the HTML by passing the string as the context:
$ = require('cheerio');
$('ul', '<ul id="fruits">...</ul>');
Or as the root:
$ = require('cheerio');
$('li', 'ul', '<ul id="fruits">...</ul>');
You can also pass an extra object to .load() if you need to modify any
of the default parsing options:
$ = cheerio.load('<ul id="fruits">...</ul>', {
normalizeWhitespace: true,
xmlMode: true
});
These parsing options are taken directly from htmlparser, therefore any options that can be used in htmlparser are valid in cheerio as well. The default options are:
{
normalizeWhitespace: false,
xmlMode: false,
lowerCaseTags: false
}
For a list of options and their effects, see this and this.
Cheerio's selector implementation is nearly identical to jQuery's, so the API is very similar.
selector searches within the context scope which searches within the root scope. selector and context can be an string expression, DOM Element, array of DOM elements, or cheerio object. root is typically the HTML document string.
This selector method is the starting point for traversing and manipulating the document. Like jQuery, it's the primary method for selecting elements in the document, but unlike jQuery it's built on top of the CSSSelect library, which implements most of the Sizzle selectors.
$('.apple', '#fruits').text()
//=> Apple
$('ul .pear').attr('class')
//=> pear
$('li[class=orange]').html()
//=> <li class="orange">Orange</li>
Methods for getting and modifying attributes.
Method for getting and setting attributes. Gets the attribute value for only the first element in the matched set. If you set an attribute's value to null, you remove that attribute. You may also pass a map and function like jQuery.
$('ul').attr('id')
//=> fruits
$('.apple').attr('id', 'favorite').html()
//=> <li class="apple" id="favorite">Apple</li>
See http://api.jquery.com/attr/ for more information
Method for getting and setting data attributes. Gets or sets the data attribute value for only the first element in the matched set.
$('<div data-apple-color="red"></div>').data()
//=> { appleColor: 'red' }
$('<div data-apple-color="red"></div>').data('data-apple-color')
//=> 'red'
var apple = $('.apple').data('kind', 'mac')
apple.data('kind')
//=> 'mac'
See http://api.jquery.com/data/ for more information
Method for getting and setting the value of input, select, and textarea. Note: Support for map, and function has not been added yet.
$('input[type="text"]').val()
=> input_text
$('input[type="text"]').val('test').html()
=> <input type="text" value="test"/>
Method for removing attributes by name.
$('.pear').removeAttr('class').html()
//=> <li>Pear</li>
Check to see if any of the matched elements have the given className.
$('.pear').hasClass('pear')
//=> true
$('apple').hasClass('fruit')
//=> false
$('li').hasClass('pear')
//=> true
Adds class(es) to all of the matched elements. Also accepts a function like jQuery.
$('.pear').addClass('fruit').html()
//=> <li class="pear fruit">Pear</li>
$('.apple').addClass('fruit red').html()
//=> <li class="apple fruit red">Apple</li>
See http://api.jquery.com/addClass/ for more information.
Removes one or more space-separated classes from the selected elements. If no className is defined, all classes will be removed. Also accepts a function like jQuery.
$('.pear').removeClass('pear').html()
//=> <li class="">Pear</li>
$('.apple').addClass('red').removeClass().html()
//=> <li class="">Apple</li>
See http://api.jquery.com/removeClass/ for more information.
Add or remove class(es) from the matched elements, depending on either the class's presence or the value of the switch argument. Also accepts a function like jQuery.
$('.apple.green').toggleClass('fruit green red').html()
//=> <li class="apple fruit red">Apple</li>
$('.apple.green').toggleClass('fruit green red', true).html()
//=> <li class="apple green fruit red">Apple</li>
See http://api.jquery.com/toggleClass/ for more information.
Checks the current list of elements and returns true if any of the elements match the selector. If using an element or Cheerio selection, returns true if any of the elements match. If using a predicate function, the function is executed in the context of the selected element, so this refers to the current element.
Get a set of descendants filtered by selector of each element in the current set of matched elements.
$('#fruits').find('li').length
//=> 3
Get the parent of each element in the current set of matched elements, optionally filtered by a selector.
$('.pear').parent().attr('id')
//=> fruits
Get a set of parents filtered by selector of each element in the current set of match elements.
$('.orange').parents().length
// => 2
$('.orange').parents('#fruits').length
// => 1
For each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree.
$('.orange').closest()
// => []
$('.orange').closest('.apple')
// => []
$('.orange').closest('li')
// => [<li class="orange">Orange</li>]
$('.orange').closest('#fruits')
// => [<ul id="fruits"> ... </ul>]
Gets the next sibling of the first selected element.
$('.apple').next().hasClass('orange')
//=> true
Gets all the following siblings of the first selected element.
$('.apple').nextAll()
//=> [<li class="orange">Orange</li>, <li class="pear">Pear</li>]
Gets all the following siblings up to but not including the element matched by the selector.
$('.apple').nextUntil('.pear')
//=> [<li class="orange">Orange</li>]
Gets the previous sibling of the first selected element.
$('.orange').prev().hasClass('apple')
//=> true
Gets all the preceding siblings of the first selected element.
$('.pear').prevAll()
//=> [<li class="orange">Orange</li>, <li class="apple">Apple</li>]
Gets all the preceding siblings up to but not including the element matched by the selector.
$('.pear').prevUntil('.apple')
//=> [<li class="orange">Orange</li>]
Gets the elements matching the specified range
$('li').slice(1).eq(0).text()
//=> 'Orange'
$('li').slice(1, 2).length
//=> 1
Gets the first selected element's siblings, excluding itself.
$('.pear').siblings().length
//=> 2
$('.pear').siblings('.orange').length
//=> 1
Gets the children of the first selected element.
$('#fruits').children().length
//=> 3
$('#fruits').children('.pear').text()
//=> Pear
Gets the children of each element in the set of matched elements, including text and comment nodes.
$('#fruits').contents().length
//=> 3
Iterates over a cheerio object, executing a function for each matched element. When the callback is fired, the function is fired in the context of the DOM element, so this refers to the current element, which is equivalent to the function parameter element. To break out of the each loop early, return with false.
var fruits = [];
$('li').each(function(i, elem) {
fruits[i] = $(this).text();
});
fruits.join(', ');
//=> Apple, Orange, Pear
Pass each element in the current matched set through a function, producing a new Cheerio object containing the return values. The function can return an individual data item or an array of data items to be inserted into the resulting set. If an array is returned, the elements inside the array are inserted into the set. If the function returns null or undefined, no element will be inserted.
$('li').map(function(i, el) {
// this === el
return $('<div>').text($(this).text());
}).html();
//=> <div>apple</div><div>orange</div><div>pear</div>
Iterates over a cheerio object, reducing the set of selector elements to those that match the selector or pass the function's test. When a Cheerio selection is specified, return only the elements contained in that selection. When an element is specified, return only that element (if it is contained in the original selection). If using the function method, the function is executed in the context of the selected element, so this refers to the current element.
Selector:
$('li').filter('.orange').attr('class');
//=> orange
Function:
$('li').filter(function(i, el) {
// this === el
return $(this).attr('class') === 'orange';
}).attr('class')
//=> orange
Will select the first element of a cheerio object
$('#fruits').children().first().text()
//=> Apple
Will select the last element of a cheerio object
$('#fruits').children().last().text()
//=> Pear
Reduce the set of matched elements to the one at the specified index. Use .eq(-i) to count backwards from the last selected element.
$('li').eq(0).text()
//=> Apple
$('li').eq(-1).text()
//=> Pear
End the most recent filtering operation in the current chain and return the set of matched elements to its previous state.
$('li').eq(0).end().length
//=> 3
Methods for modifying the DOM structure.
Inserts content as the last child of each of the selected elements.
$('ul').append('<li class="plum">Plum</li>')
$.html()
//=> <ul id="fruits">
// <li class="apple">Apple</li>
// <li class="orange">Orange</li>
// <li class="pear">Pear</li>
// <li class="plum">Plum</li>
// </ul>
Inserts content as the first child of each of the selected elements.
$('ul').prepend('<li class="plum">Plum</li>')
$.html()
//=> <ul id="fruits">
// <li class="plum">Plum</li>
// <li class="apple">Apple</li>
// <li class="orange">Orange</li>
// <li class="pear">Pear</li>
// </ul>
Insert content next to each element in the set of matched elements.
$('.apple').after('<li class="plum">Plum</li>')
$.html()
//=> <ul id="fruits">
// <li class="apple">Apple</li>
// <li class="plum">Plum</li>
// <li class="orange">Orange</li>
// <li class="pear">Pear</li>
// </ul>
Insert content previous to each element in the set of matched elements.
$('.apple').before('<li class="plum">Plum</li>')
$.html()
//=> <ul id="fruits">
// <li class="plum">Plum</li>
// <li class="apple">Apple</li>
// <li class="orange">Orange</li>
// <li class="pear">Pear</li>
// </ul>
Removes the set of matched elements from the DOM and all their children. selector filters the set of matched elements to be removed.
$('.pear').remove()
$.html()
//=> <ul id="fruits">
// <li class="apple">Apple</li>
// <li class="orange">Orange</li>
// </ul>
Replaces matched elements with content.
var plum = $('<li class="plum">Plum</li>')
$('.pear').replaceWith(plum)
$.html()
//=> <ul id="fruits">
// <li class="apple">Apple</li>
// <li class="orange">Orange</li>
// <li class="plum">Plum</li>
// </ul>
Empties an element, removing all it's children.
$('ul').empty()
$.html()
//=> <ul id="fruits"></ul>
Gets an html content string from the first selected element. If htmlString is specified, each selected element's content is replaced by the new content.
$('.orange').html()
//=> Orange
$('#fruits').html('<li class="mango">Mango</li>').html()
//=> <li class="mango">Mango</li>
Get the combined text contents of each element in the set of matched elements, including their descendants.. If textString is specified, each selected element's content is replaced by the new text content.
$('.orange').text()
//=> Orange
$('ul').text()
//=> Apple
// Orange
// Pear
Get the value of a style property for the first element in the set of matched elements or set one or more CSS properties for every matched element.
When you're ready to render the document, you can use the html utility function:
$.html()
//=> <ul id="fruits">
// <li class="apple">Apple</li>
// <li class="orange">Orange</li>
// <li class="pear">Pear</li>
// </ul>
If you want to return the outerHTML you can use $.html(selector):
$.html('.pear')
//=> <li class="pear">Pear</li>
By default, html will leave some tags open. Sometimes you may instead want to render a valid XML document. For example, you might parse the following XML snippet:
$ = cheerio.load('<media:thumbnail url="http://www.foo.com/keyframe.jpg" width="75" height="50" time="12:05:01.123"/>');
... and later want to render to XML. To do this, you can use the 'xml' utility function:
$.xml()
//=> <media:thumbnail url="http://www.foo.com/keyframe.jpg" width="75" height="50" time="12:05:01.123"/>
DOM element methods that don't fit anywhere else
Retrieve all the DOM elements contained in the jQuery set, as an array.
$('li').toArray()
//=> [ {...}, {...}, {...} ]
Clone the cheerio object.
var moreFruit = $('#fruits').clone()
Sometimes you need to work with the top-level root element. To query it, you can use $.root().
$.root().append('<ul id="vegetables"></ul>').html();
//=> <ul id="fruits">...</ul><ul id="vegetables"></ul>
Checks to see if the contained DOM element is a descendent of the container DOM element.
Parses a string into an array of DOM nodes. The context argument has no meaning for Cheerio, but it is maintained for API compatability.
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 has high-test coverage, you can view the report here.
To run the test suite, download the repository, then within the cheerio directory, run:
make setup
make test
This will download the development packages and run the test suite.
These are some of the contributors that have made cheerio possible:
project : cheerio
repo age : 2 years, 1 month
active : 196 days
commits : 591
files : 32
authors :
293 Matt Mueller 49.6%
102 Matthew Mueller 17.3%
52 Mike Pennisi 8.8%
47 David Chambers 8.0%
15 Siddharth Mahendraker 2.5%
11 Adam Bretz 1.9%
7 ironchefpython 1.2%
6 Jarno Leppänen 1.0%
5 Ben Sheldon 0.8%
5 Ryan Schmukler 0.8%
5 Jos Shepherd 0.8%
4 Maciej Adwent 0.7%
4 Amir Abu Shareb 0.7%
3 Felix Böhm 0.5%
3 jeremy.dentel@brandingbrand.com 0.5%
3 Andi Neck 0.5%
2 alexbardas 0.3%
2 Ali Farhadi 0.3%
2 Thomas Heymann 0.3%
2 Wayne Larsen 0.3%
2 Rob Ashton 0.3%
2 Chris Khoo 0.3%
1 xiaohwan 0.2%
1 Chris O'Hara 0.2%
1 Felix Böhm 0.2%
1 Jeremy Hubble 0.2%
1 Manuel Alabor 0.2%
1 Matt Liegey 0.2%
1 Ben Atkin 0.2%
1 Rich Trott 0.2%
1 Rob "Hurricane" Ashton 0.2%
1 Simon Boudrias 0.2%
1 Sindre Sorhus 0.2%
1 Timm Preetz 0.2%
1 mattym 0.2%
1 nevermind 0.2%
This library stands on the shoulders of some incredible developers. A special thanks to:
• @FB55 for node-htmlparser2 & CSSSelect:
Felix has a knack for writing speedy parsing engines. He completely re-wrote both @tautologistic's node-htmlparser and @harry's node-soupselect from the ground up, making both of them much faster and more flexible. Cheerio would not be possible without his foundational work
• @jQuery team for jQuery: The core API is the best of it's class and despite dealing with all the browser inconsistencies the code base is extremely clean and easy to follow. Much of cheerio's implementation and documentation is from jQuery. Thanks guys.
• @visionmedia: The style, the structure, the open-source"-ness" of this library comes from studying TJ's style and using many of his libraries. This dude consistently pumps out high-quality libraries and has always been more than willing to help or answer questions. You rock TJ.
(The MIT License)
Copyright (c) 2012 Matt Mueller <mattmuelle@gmail.com>
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.
FAQs
The fast, flexible & elegant library for parsing and manipulating HTML and XML.
The npm package cheerio receives a total of 7,670,444 weekly downloads. As such, cheerio popularity was classified as popular.
We found that cheerio demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.