cheerio

constructor

constructor(
    elements: ArrayLike<T>,
    root: Cheerio<Document>,
    options: InternalOptions
);

• Instance of cheerio. Methods are specified in the modules. Usage of this constructor is not recommended. Please use $.load instead.

  Parameter elements

  The new selection.

  Parameter root

  Sets the root node.

  Parameter options

  Options for the instance.

property length

length: number;

property options

options: InternalOptions;

property prevObject

prevObject: Cheerio<any>;

property cheerio

cheerio: '[cheerio object]';

property splice

splice: typeof Array.prototype.splice;

property fn

fn: typeof Cheerio.prototype;

• Mimic jQuery's prototype alias for plugin authors.

property load

load: ReturnType<typeof getLoad>;

• The .load static method defined on the "loaded" Cheerio factory function is deprecated. Users are encouraged to instead use the load function exported by the Cheerio module.

  Example 1

  const $ = cheerio.load('<h1>Hello, <span>world</span>.</h1>');

  Deprecated

  Use the load function exported by the Cheerio module. Deprecated

call signature

<T extends AnyNode, S extends string>(
    selector?: S | BasicAcceptedElems<T>,
    context?: BasicAcceptedElems<AnyNode> | null,
    root?: BasicAcceptedElems<Document>,
    options?: CheerioOptions
): Cheerio<S extends SelectorType ? Element : T>;

• 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.

  selector searches within the context scope, which searches within the root scope.

  Parameter selector

  Either a selector to look for within the document, or the contents of a new Cheerio instance.

  Parameter context

  Either a selector to look for within the root, or the contents of the document to query.

  Parameter root

  Optional HTML document string.

  Example 1

  $('ul .pear').attr('class');
  //=> pear
  
  $('li[class=orange]').html();
  //=> Orange
  
  $('.apple', '#fruits').text();
  //=> Apple

  Optionally, you can also load HTML by passing the string as the selector:

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

  Or the context:

  $('ul', '<ul id="fruits">...</ul>');

  Or as the root:

  $('li', 'ul', '<ul id="fruits">...</ul>');

property baseURI

baseURI?: string | URL;

• The base URI for the document. Used to resolve the href and src props.

property pseudos

pseudos?: SelectOptions['pseudos'];

• Extension point for pseudo-classes.

  Maps from names to either strings of functions.

  - A string value is a selector that the element must match to be selected. - A function is called with the element as its first argument, and optional parameters second. If it returns true, the element is selected.

  Example 1

  const $ = cheerio.load(
    '<div class="foo"></div><div data-bar="boo"></div>',
    {
      pseudos: {
        // `:foo` is an alias for `div.foo`
        foo: 'div.foo',
        // `:bar(val)` is equivalent to `[data-bar=val s]`
        bar: (el, val) => el.attribs['data-bar'] === val,
      },
    },
  );
  
  $(':foo').length; // 1
  $('div:bar(boo)').length; // 1
  $('div:bar(baz)').length; // 0

property quirksMode

quirksMode?: SelectOptions['quirksMode'];

• Is the document in quirks mode?

  This will lead to .className and #id being case-insensitive.

  false

property xml

xml?: HTMLParser2Options | boolean;

• Recommended way of configuring htmlparser2 when wanting to parse XML.

  This will switch Cheerio to use htmlparser2.

  false

property xmlMode

xmlMode?: boolean;

• Enable xml mode, which will switch Cheerio to use htmlparser2.

  Deprecated

  Please use the xml option instead. false

property requestOptions

requestOptions?: UndiciStreamOptions;

• The options passed to undici's stream method.

property encoding

encoding?: SnifferOptions;