Interface: CheerioAPI()

A querying function, bound to a document created from the provided markup.

Also provides several helper methods for dealing with the document as a whole.

Extends

StaticType

CheerioAPI<T, S>(
   selector?, 
   context?, 
   root?, 
options?): Cheerio<S extends SelectorType ? Element : T>;

Defined in: src/load.ts

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.

Type Parameters

Type Parameter
`T` extends `AnyNode`
`S` extends `string`

Parameters

Parameter	Type	Description
`selector?`	\| `S` \| `BasicAcceptedElems`<`T`>	Either a selector to look for within the document, or the contents of a new Cheerio instance.
`context?`	\| `BasicAcceptedElems`<`AnyNode`> \| `null`	Either a selector to look for within the root, or the contents of the document to query.
`root?`	`BasicAcceptedElems`<`Document`>	Optional HTML document string.
`options?`	`CheerioOptions`	-

Returns

Cheerio<S extends SelectorType ? Element : T>

Example

$('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>');

Deprecated

load()

load: (content, options?, isDocument) => CheerioAPI;

Defined in: src/load.ts

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.

Parameters

Parameter	Type	Default value
`content`	\| `string` \| `AnyNode` \| `AnyNode`[] \| `Buffer`<`ArrayBufferLike`>	`undefined`
`options?`	`CheerioOptions` \| `null`	`undefined`
`isDocument?`	`boolean`	`true`

Returns

CheerioAPI

Deprecated

Use the load function exported by the Cheerio module.

Example

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

Other

fn

fn: Cheerio<any>;

Defined in: src/load.ts

Mimic jQuery’s prototype alias for plugin authors.

contains

Re-exports contains

merge

Re-exports merge

Static

extract()

extract<M>(this, map): ExtractedMap<M>;

Defined in: src/static.ts

Extract multiple values from a document, and store them in an object.

Type Parameters

Type Parameter
`M` extends `ExtractMap`

Parameters

Parameter	Type	Description
`this`	`CheerioAPI`	-
`map`	`M`	An object containing key-value pairs. The keys are the names of the properties to be created on the object, and the values are the selectors to be used to extract the values.

Returns

ExtractedMap<M>

An object containing the extracted values.

Inherited from

StaticType.extract

html()

Call Signature

html(this, options?): string;

Defined in: src/static.ts

Renders the document.

Parameters

Parameter	Type	Description
`this`	`CheerioAPI`	-
`options?`	`CheerioOptions`	Options for the renderer.

Returns

string

The rendered document.

Inherited from

StaticType.html

Call Signature

html(
   this, 
   dom?, 
   options?): string;

Defined in: src/static.ts

Renders the document.

Parameters

Parameter	Type	Description
`this`	`CheerioAPI`	-
`dom?`	`BasicAcceptedElems`<`AnyNode`>	Element to render.
`options?`	`CheerioOptions`	Options for the renderer.

Returns

string

The rendered document.

Inherited from

StaticType.html

parseHTML()

Call Signature

parseHTML(
   this, 
   data, 
   context?, 
   keepScripts?): AnyNode[];

Defined in: src/static.ts

Parses a string into an array of DOM nodes. The context argument has no meaning for Cheerio, but it is maintained for API compatibility with jQuery.

Parameters

Parameter	Type	Description
`this`	`CheerioAPI`	-
`data`	`string`	Markup that will be parsed.
`context?`	`unknown`	Will be ignored. If it is a boolean it will be used as the value of `keepScripts`.
`keepScripts?`	`boolean`	If false all scripts will be removed.

Returns

AnyNode[]

The parsed DOM.

Alias

Cheerio.parseHTML

See

https://api.jquery.com/jQuery.parseHTML/

Inherited from

StaticType.parseHTML

Call Signature

parseHTML(this, data?): null;

Defined in: src/static.ts

Parses a string into an array of DOM nodes. The context argument has no meaning for Cheerio, but it is maintained for API compatibility with jQuery.

Parameters

Parameter	Type	Description
`this`	`CheerioAPI`	-
`data?`	`""` \| `null`	Markup that will be parsed.

Returns

null

The parsed DOM.

Alias

Cheerio.parseHTML

See

https://api.jquery.com/jQuery.parseHTML/

Inherited from

StaticType.parseHTML

root()

root(this): Cheerio<Document>;

Defined in: src/static.ts

Sometimes you need to work with the top-level root element. To query it, you can use $.root().

Parameters

Parameter	Type
`this`	`CheerioAPI`

Returns

Cheerio<Document>

Cheerio instance wrapping the root node.

Example

$.root().append('<ul id="vegetables"></ul>').html();
//=> <ul id="fruits">...</ul><ul id="vegetables"></ul>

Alias

Cheerio.root

Inherited from

StaticType.root

text()

text(this, elements?): string;

Defined in: src/static.ts

Render the document as text.

This returns the textContent of the passed elements. The result will include the contents of <script> and <style> elements. To avoid this, use .prop('innerText') instead.

Parameters

Parameter	Type	Description
`this`	`void` \| `CheerioAPI`	-
`elements?`	`ArrayLike`<`AnyNode`>	Elements to render.

Returns

string

The rendered document.

Inherited from

StaticType.text

xml()

xml(this, dom?): string;

Defined in: src/static.ts

Render the document as XML.

Parameters

Parameter	Type	Description
`this`	`CheerioAPI`	-
`dom?`	`BasicAcceptedElems`<`AnyNode`>	Element to render.

Returns

string

THe rendered document.

Inherited from

StaticType.xml