cheerio README

The project's README from github.com/cheeriojs/cheerio. As one markdown file: README.md.

cheerio

The fast, flexible, and elegant library for parsing and manipulating HTML and XML.
Build Status Coverage OpenCollective backers OpenCollective sponsors OpenSSF Scorecard

中文文档 (Chinese Readme)

import * as cheerio from 'cheerio';
const $ = cheerio.load('<h2 class="title">Hello world</h2>');

$('h2.title').text('Hello there!');
$('h2').addClass('welcome');

$.html();
//=> <html><head></head><body><h2 class="title welcome">Hello there!</h2></body></html>

Installation

Install Cheerio using a package manager like npm, yarn, bun, or Deno.

npm install cheerio
# or
bun add cheerio
# or
deno install 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

Loading

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.

// ESM or TypeScript:
import * as cheerio from 'cheerio';

// In other environments:
const cheerio = require('cheerio');

const $ = cheerio.load('<ul id="fruits">...</ul>');

$.html();
//=> <html><head></head><body><ul id="fruits">...</ul></body></html>

Selectors

Once you've loaded the HTML, you can use jQuery-style selectors to find elements within the document.

$( selector, [context], [root] )

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.

$('.apple', '#fruits').text();
//=> Apple

$('ul .pear').attr('class');
//=> pear

$('li[class=orange]').html();
//=> Orange

Rendering

When you're ready to render the document, you can call the html method on the "root" selection:

$.root().html();
//=>  <html>
//      <head></head>
//      <body>
//        <ul id="fruits">
//          <li class="apple">Apple</li>
//          <li class="orange">Orange</li>
//          <li class="pear">Pear</li>
//        </ul>
//      </body>
//    </html>

If you want to render the outerHTML of a selection, you can use the outerHTML prop:

$('.pear').prop('outerHTML');
//=> <li class="pear">Pear</li>

You may also render the text content of a Cheerio object using the text method:

const $ = cheerio.load('This is <em>content</em>.');
$('body').text();
//=> This is content.

The "DOM Node" object

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

https://vimeo.com/31950192

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

ScrapingBee Github AirBnB

Other Sponsors

OnlineCasinosSpelen Nieuwe-Casinos.net Rapidproxy

Backers

Become a backer to show your support for Cheerio and help us maintain and improve this open source project.

Vasy Kafidoff

License

MIT

cheerio (cheeriojs/cheerio)

Searching Database…

30.5K ·GitHub
Cheerio
Что это такое?Cheerio — это быстрая и гибкая библиотека для разбора и изменения HTML и XML. Она реализует часть основного API jQuery, так что если вы знаете селекторы jQuery, вы уже знакомы с большей частью библиотеки.
Это по сути jQuery или что-то другое?Это JavaScript-библиотека, реализующая подмножество основного jQuery, но без несовместимостей DOM и браузерного мусора. В отличие от jQuery, у неё нет встроенной DOM страницы — HTML, с которым нужно работать, вы загружаете сами.
Как подключить её к проекту?Установите любым JavaScript-пакетным менеджером — npm, yarn, bun или Deno (npm install cheerio). Затем загрузите HTML-строку, найдите элементы селекторами в стиле jQuery и получите результат через html() или text().
Какая версия Node нужна, и нужно ли что-то ещё настраивать?Пакет требует Node >= 22.19.0 — это довольно свежая версия, сначала проверьте своё окружение. Больше ничего не нужно: движки для разбора идут в комплекте как встроенные зависимости.
Справится ли она с грязным реальным HTML и XML?Да — она разбирает практически любой документ HTML или XML. По умолчанию для HTML используется parse5, а при желании можно включить более терпимый к ошибкам htmlparser2, так что сломанная разметка её не остановит.
Она работает только под Node или ещё и в браузере?И там, и там — в README сказано, что она работает и в браузере, и на сервере. Поскольку это чистый TypeScript/JavaScript без нативного кода, требований к операционной системе нет.
После того как я нашёл и изменил элементы, как получить результат наружу?Вызовите html() на корневой выборке, чтобы отрендерить документ, прочитайте свойство outerHTML, чтобы получить внешнюю разметку выборки, или используйте text(), если нужен только текст.
Насколько гибкий вызов селектора?Основной метод $(selector, context, root) ищет внутри области context, которая, в свою очередь, ищет внутри области root. Селектор и context могут быть строковым выражением, DOM-элементом, массивом DOM-элементов или объектом Cheerio.
Почему для парсинга сайтов лучше она, а не JSDOM плюс jQuery?Скринкаст в README показывает, насколько быстрее Cheerio по сравнению с JSDOM + jQuery: её простая и последовательная модель DOM делает разбор, изменение и рендеринг невероятно эффективными.
Найденные элементы ведут себя как настоящие DOM-узлы?Они сильно напоминают DOM-узлы браузера — у них можно ожидать знакомых свойств, таких как tagName, parentNode, previousSibling, nextSibling, firstChild и childNodes.
What are similar projects?goquery, marked, jquery, turndown, masonry, jsoup, jsdom, velocity
Which topics is it in?xml, jquery, parsing, scraper, scraping, dom, parser, web-scraping, javascript-library, browser, hacktoberfest, html
Creator
cheeriojs
Size
21.7 MB
Stars
30.5K
Updated
CommitOct 17Releasev1.2.0Jan 23
Age
15y
Commits · 90 Days