Abstract Class: Cheerio<T>

Defined in: src/cheerio.ts

The cheerio class is the central class of the library. It wraps a set of elements and provides an API for traversing, modifying, and interacting with the set.

Loading a document will return the Cheerio class bound to the root element of the document. The class will be instantiated when querying the document (when calling $('selector')).

Example

<ul id="fruits">
  <li class="apple">Apple</li>
  <li class="orange">Orange</li>
  <li class="pear">Pear</li>
</ul>

Extends

• MethodsType.Iterable<T>

Type Parameters

Implements

• ArrayLike<T>

Indexable

[index: number]: T

Attributes

addClass()

addClass<T, R>(this, value?): R;

Defined in: src/api/attributes.ts

Adds class(es) to all of the matched elements. Also accepts a function.

Type Parameters

Parameters

Returns

R

The instance itself.

Example

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

$('.apple').addClass('fruit red').prop('outerHTML');
//=> <li class="apple fruit red">Apple</li>

See

https://api.jquery.com/addClass/

attr()

Call Signature

attr<T>(this, name): string | undefined;

Defined in: src/api/attributes.ts

Method for getting attributes. Gets the attribute value for only the first element in the matched set.

Type Parameters

Parameters

Returns

string | undefined

The attribute’s value.

Example

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

See

https://api.jquery.com/attr/

Call Signature

attr<T>(this): 
  | Record<string, string>
  | undefined;

Defined in: src/api/attributes.ts

Method for getting all attributes and their values of the first element in the matched set.

Type Parameters

Parameters

Returns

| Record<string, string> | undefined

The attribute’s values.

Example

$('ul').attr();
//=> { id: 'fruits' }

See

https://api.jquery.com/attr/

Call Signature

attr<T>(
   this, 
   name, 
value?): Cheerio<T>;

Defined in: src/api/attributes.ts

Method for setting attributes. Sets the attribute value for all elements 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.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Example

$('.apple').attr('id', 'favorite').prop('outerHTML');
//=> <li class="apple" id="favorite">Apple</li>

See

https://api.jquery.com/attr/

Call Signature

attr<T>(this, values): Cheerio<T>;

Defined in: src/api/attributes.ts

Method for setting multiple attributes at once. Sets the attribute value for all elements in the matched set. If you set an attribute’s value to null, you remove that attribute.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Example

$('.apple').attr({ id: 'favorite' }).prop('outerHTML');
//=> <li class="apple" id="favorite">Apple</li>

See

https://api.jquery.com/attr/

data()

Call Signature

data<T>(this, name): unknown;

Defined in: src/api/attributes.ts

Method for getting data attributes, for only the first element in the matched set.

Type Parameters

Parameters

Returns

unknown

The data attribute’s value, or undefined if the attribute does not exist.

Example

$('<div data-apple-color="red"></div>').data('apple-color');
//=> 'red'

See

https://api.jquery.com/data/

Call Signature

data<T>(this): Record<string, unknown>;

Defined in: src/api/attributes.ts

Method for getting all of an element’s data attributes, for only the first element in the matched set.

Type Parameters

Parameters

Returns

Record<string, unknown>

A map with all of the data attributes.

Example

$('<div data-apple-color="red"></div>').data();
//=> { appleColor: 'red' }

See

https://api.jquery.com/data/

Call Signature

data<T>(
   this, 
   name, 
value): Cheerio<T>;

Defined in: src/api/attributes.ts

Method for setting data attributes, for only the first element in the matched set.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Example

const apple = $('.apple').data('kind', 'mac');

apple.data('kind');
//=> 'mac'

See

https://api.jquery.com/data/

Call Signature

data<T>(this, values): Cheerio<T>;

Defined in: src/api/attributes.ts

Method for setting multiple data attributes at once, for only the first element in the matched set.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Example

const apple = $('.apple').data({ kind: 'mac' });

apple.data('kind');
//=> 'mac'

See

https://api.jquery.com/data/

hasClass()

hasClass<T>(this, className): boolean;

Defined in: src/api/attributes.ts

Check to see if any of the matched elements have the given className.

Type Parameters

Parameters

Returns

boolean

Indicates if an element has the given className.

Example

$('.pear').hasClass('pear');
//=> true

$('apple').hasClass('fruit');
//=> false

$('li').hasClass('pear');
//=> true

See

https://api.jquery.com/hasClass/

prop()

Call Signature

prop<T>(this, name): string | undefined;

Defined in: src/api/attributes.ts

Method for getting and setting properties. Gets the property value for only the first element in the matched set.

Type Parameters

Parameters

Returns

string | undefined

If value is specified the instance itself, otherwise the prop’s value.

Example

$('input[type="checkbox"]').prop('checked');
//=> false

$('input[type="checkbox"]').prop('checked', true).val();
//=> ok

See

https://api.jquery.com/prop/

Call Signature

prop<T>(this, name): string | null;

Defined in: src/api/attributes.ts

Method for getting and setting properties. Gets the property value for only the first element in the matched set.

Type Parameters

Parameters

Returns

string | null

If value is specified the instance itself, otherwise the prop’s value.

Example

$('input[type="checkbox"]').prop('checked');
//=> false

$('input[type="checkbox"]').prop('checked', true).val();
//=> ok

See

https://api.jquery.com/prop/

Call Signature

prop<T>(this, name): StyleProp | undefined;

Defined in: src/api/attributes.ts

Get a parsed CSS style object.

Type Parameters

Parameters

Returns

StyleProp | undefined

The style object, or undefined if the element has no style attribute.

Call Signature

prop<T>(this, name): string | undefined;

Defined in: src/api/attributes.ts

Resolve href or src of supported elements. Requires the baseURI option to be set, and a global URL object to be part of the environment.

Type Parameters

Parameters

Returns

string | undefined

The resolved URL, or undefined if the element is not supported.

Example

$('<img src="image.png">').prop('src');
//=> 'https://example.com/image.png'

Call Signature

prop<T, K>(this, name): Element[K];

Defined in: src/api/attributes.ts

Get a property of an element.

Type Parameters

Parameters

Returns

Element[K]

The property’s value.

Call Signature

prop<T, K>(
   this, 
   name, 
value): Cheerio<T>;

Defined in: src/api/attributes.ts

Set a property of an element.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Call Signature

prop<T>(this, map): Cheerio<T>;

Defined in: src/api/attributes.ts

Set multiple properties of an element.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Example

$('input[type="checkbox"]').prop({
  checked: true,
  disabled: false,
});

Call Signature

prop<T>(
   this, 
   name, 
value): Cheerio<T>;

Defined in: src/api/attributes.ts

Set a property of an element.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Call Signature

prop<T>(this, name): string;

Defined in: src/api/attributes.ts

Get a property of an element.

Type Parameters

Parameters

Returns

string

The property’s value.

removeAttr()

removeAttr<T>(this, name): Cheerio<T>;

Defined in: src/api/attributes.ts

Method for removing attributes by name.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Example

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

$('.apple').attr('id', 'favorite');
$('.apple').removeAttr('id class').prop('outerHTML');
//=> <li>Apple</li>

See

https://api.jquery.com/removeAttr/

removeClass()

removeClass<T, R>(this, name?): R;

Defined in: src/api/attributes.ts

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.

Type Parameters

Parameters

Returns

R

The instance itself.

Example

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

$('.apple').addClass('red').removeClass().prop('outerHTML');
//=> <li class="">Apple</li>

See

https://api.jquery.com/removeClass/

toggleClass()

toggleClass<T, R>(
   this, 
   value?, 
   stateVal?): R;

Defined in: src/api/attributes.ts

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.

Type Parameters

Parameters

Returns

R

The instance itself.

Example

$('.apple.green').toggleClass('fruit green red').prop('outerHTML');
//=> <li class="apple fruit red">Apple</li>

$('.apple.green').toggleClass('fruit green red', true).prop('outerHTML');
//=> <li class="apple green fruit red">Apple</li>

See

https://api.jquery.com/toggleClass/

val()

Call Signature

val<T>(this): string | string[] | undefined;

Defined in: src/api/attributes.ts

Method for getting the value of input, select, and textarea. Note: Support for map, and function has not been added yet.

Type Parameters

Parameters

Returns

string | string[] | undefined

The value.

Example

$('input[type="text"]').val();
//=> input_text

See

https://api.jquery.com/val/

Call Signature

val<T>(this, value): Cheerio<T>;

Defined in: src/api/attributes.ts

Method for setting the value of input, select, and textarea. Note: Support for map, and function has not been added yet.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Example

$('input[type="text"]').val('test').prop('outerHTML');
//=> <input type="text" value="test"/>

See

https://api.jquery.com/val/

CSS

css()

Set multiple CSS properties for every matched element.

Param

The names of the properties.

Param

The new values.

See

https://api.jquery.com/css/

Call Signature

css<T>(this, names?): 
  | Record<string, string>
  | undefined;

Defined in: src/api/css.ts

Get the value of a style property for the first element in the set of matched elements.

Type Parameters

Parameters

Returns

| Record<string, string> | undefined

A map of all of the style properties.

See

https://api.jquery.com/css/

Call Signature

css<T>(this, name): string | undefined;

Defined in: src/api/css.ts

Get the value of a style property for the first element in the set of matched elements.

Type Parameters

Parameters

Returns

string | undefined

The property value for the given name.

See

https://api.jquery.com/css/

Call Signature

css<T>(
   this, 
   prop, 
val): Cheerio<T>;

Defined in: src/api/css.ts

Set one CSS property for every matched element.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

See

https://api.jquery.com/css/

Call Signature

css<T>(this, map): Cheerio<T>;

Defined in: src/api/css.ts

Set multiple CSS properties for every matched element.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

See

https://api.jquery.com/css/

Forms

serialize()

serialize<T>(this): string;

Defined in: src/api/forms.ts

Encode a set of form elements as a string for submission.

Type Parameters

Parameters

Returns

string

The serialized form.

Example

$('<form><input name="foo" value="bar" /></form>').serialize();
//=> 'foo=bar'

See

https://api.jquery.com/serialize/

serializeArray()

serializeArray<T>(this): {
  name: string;
  value: string;
}[];

Defined in: src/api/forms.ts

Encode a set of form elements as an array of names and values.

Type Parameters

Parameters

Returns

{ name: string; value: string; }[]

The serialized form.

Example

$('<form><input name="foo" value="bar" /></form>').serializeArray();
//=> [ { name: 'foo', value: 'bar' } ]

See

https://api.jquery.com/serializeArray/

Manipulation

append()

append: <T>(this, ...elems) => Cheerio<T>;

Defined in: src/api/manipulation.ts

Inserts content as the last child of each of the selected elements.

Type Parameters

Parameters

Returns

Cheerio<T>

Example

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

See

https://api.jquery.com/append/

prepend()

prepend: <T>(this, ...elems) => Cheerio<T>;

Defined in: src/api/manipulation.ts

Inserts content as the first child of each of the selected elements.

Type Parameters

Parameters

Returns

Cheerio<T>

Example

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

See

https://api.jquery.com/prepend/

wrap()

wrap: <T>(this, wrapper) => Cheerio<T>;

Defined in: src/api/manipulation.ts

The .wrap() function can take any string or object that could be passed to the $() factory function to specify a DOM structure. This structure may be nested several levels deep, but should contain only one inmost element. A copy of this structure will be wrapped around each of the elements in the set of matched elements. This method returns the original set of elements for chaining purposes.

Type Parameters

Parameters

Returns

Cheerio<T>

Example

const redFruit = $('<div class="red-fruit"></div>');
$('.apple').wrap(redFruit);

//=> <ul id="fruits">
//     <div class="red-fruit">
//      <li class="apple">Apple</li>
//     </div>
//     <li class="orange">Orange</li>
//     <li class="plum">Plum</li>
//   </ul>

const healthy = $('<div class="healthy"></div>');
$('li').wrap(healthy);

//=> <ul id="fruits">
//     <div class="healthy">
//       <li class="apple">Apple</li>
//     </div>
//     <div class="healthy">
//       <li class="orange">Orange</li>
//     </div>
//     <div class="healthy">
//        <li class="plum">Plum</li>
//     </div>
//   </ul>

See

https://api.jquery.com/wrap/

wrapInner()

wrapInner: <T>(this, wrapper) => Cheerio<T>;

Defined in: src/api/manipulation.ts

The .wrapInner() function can take any string or object that could be passed to the $() factory function to specify a DOM structure. This structure may be nested several levels deep, but should contain only one inmost element. The structure will be wrapped around the content of each of the elements in the set of matched elements.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself, for chaining.

Example

const redFruit = $('<div class="red-fruit"></div>');
$('.apple').wrapInner(redFruit);

//=> <ul id="fruits">
//     <li class="apple">
//       <div class="red-fruit">Apple</div>
//     </li>
//     <li class="orange">Orange</li>
//     <li class="pear">Pear</li>
//   </ul>

const healthy = $('<div class="healthy"></div>');
$('li').wrapInner(healthy);

//=> <ul id="fruits">
//     <li class="apple">
//       <div class="healthy">Apple</div>
//     </li>
//     <li class="orange">
//       <div class="healthy">Orange</div>
//     </li>
//     <li class="pear">
//       <div class="healthy">Pear</div>
//     </li>
//   </ul>

See

https://api.jquery.com/wrapInner/

after()

after<T>(this, ...elems): Cheerio<T>;

Defined in: src/api/manipulation.ts

Insert content next to each element in the set of matched elements.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Example

$('.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>

See

https://api.jquery.com/after/

appendTo()

appendTo<T>(this, target): Cheerio<T>;

Defined in: src/api/manipulation.ts

Insert every element in the set of matched elements to the end of the target.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Example

$('<li class="plum">Plum</li>').appendTo('#fruits');
$.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>

See

https://api.jquery.com/appendTo/

before()

before<T>(this, ...elems): Cheerio<T>;

Defined in: src/api/manipulation.ts

Insert content previous to each element in the set of matched elements.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Example

$('.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>

See

https://api.jquery.com/before/

clone()

clone<T>(this): Cheerio<T>;

Defined in: src/api/manipulation.ts

Clone the cheerio object.

Type Parameters

Parameters

Returns

Cheerio<T>

The cloned object.

Example

const moreFruit = $('#fruits').clone();

See

https://api.jquery.com/clone/

empty()

empty<T>(this): Cheerio<T>;

Defined in: src/api/manipulation.ts

Removes all children from each item in the selection. Text nodes and comment nodes are left as is.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Example

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

See

https://api.jquery.com/empty/

html()

Call Signature

html<T>(this): string | null;

Defined in: src/api/manipulation.ts

Gets an HTML content string from the first selected element.

Type Parameters

Parameters

Returns

string | null

The HTML content string.

Example

$('.orange').html();
//=> Orange

$('#fruits').html('<li class="mango">Mango</li>').html();
//=> <li class="mango">Mango</li>

See

https://api.jquery.com/html/

Call Signature

html<T>(this, str): Cheerio<T>;

Defined in: src/api/manipulation.ts

Replaces each selected element’s content with the specified content.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Example

$('.orange').html('<li class="mango">Mango</li>').html();
//=> <li class="mango">Mango</li>

See

https://api.jquery.com/html/

insertAfter()

insertAfter<T>(this, target): Cheerio<T>;

Defined in: src/api/manipulation.ts

Insert every element in the set of matched elements after the target.

Type Parameters

Parameters

Returns

Cheerio<T>

The set of newly inserted elements.

Example

$('<li class="plum">Plum</li>').insertAfter('.apple');
$.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>

See

https://api.jquery.com/insertAfter/

insertBefore()

insertBefore<T>(this, target): Cheerio<T>;

Defined in: src/api/manipulation.ts

Insert every element in the set of matched elements before the target.

Type Parameters

Parameters

Returns

Cheerio<T>

The set of newly inserted elements.

Example

$('<li class="plum">Plum</li>').insertBefore('.apple');
$.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>

See

https://api.jquery.com/insertBefore/

prependTo()

prependTo<T>(this, target): Cheerio<T>;

Defined in: src/api/manipulation.ts

Insert every element in the set of matched elements to the beginning of the target.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Example

$('<li class="plum">Plum</li>').prependTo('#fruits');
$.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>

See

https://api.jquery.com/prependTo/

remove()

remove<T>(this, selector?): Cheerio<T>;

Defined in: src/api/manipulation.ts

Removes the set of matched elements from the DOM and all their children. selector filters the set of matched elements to be removed.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Example

$('.pear').remove();
$.html();
//=>  <ul id="fruits">
//      <li class="apple">Apple</li>
//      <li class="orange">Orange</li>
//    </ul>

See

https://api.jquery.com/remove/

replaceWith()

replaceWith<T>(this, content): Cheerio<T>;

Defined in: src/api/manipulation.ts

Replaces matched elements with content.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Example

const 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>

See

https://api.jquery.com/replaceWith/

text()

Call Signature

text<T>(this): string;

Defined in: src/api/manipulation.ts

Get the combined text contents of each element in the set of matched elements, including their descendants.

Type Parameters

Parameters

Returns

string

The text contents of the collection.

Example

$('.orange').text();
//=> Orange

$('ul').text();
//=>  Apple
//    Orange
//    Pear

See

https://api.jquery.com/text/

Call Signature

text<T>(this, str): Cheerio<T>;

Defined in: src/api/manipulation.ts

Set the content of each element in the set of matched elements to the specified text.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Example

$('.orange').text('Orange');
//=> <div class="orange">Orange</div>

See

https://api.jquery.com/text/

toString()

toString<T>(this): string;

Defined in: src/api/manipulation.ts

Turns the collection to a string. Alias for .html().

Type Parameters

Parameters

Returns

string

The rendered document.

unwrap()

unwrap<T>(this, selector?): Cheerio<T>;

Defined in: src/api/manipulation.ts

The .unwrap() function, removes the parents of the set of matched elements from the DOM, leaving the matched elements in their place.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself, for chaining.

Examples

const $ = cheerio.load(
  '<div id=test>\n  <div><p>Hello</p></div>\n  <div><p>World</p></div>\n</div>',
);
$('#test p').unwrap();

//=> <div id=test>
//     <p>Hello</p>
//     <p>World</p>
//   </div>

const $ = cheerio.load(
  '<div id=test>\n  <p>Hello</p>\n  <b><p>World</p></b>\n</div>',
);
$('#test p').unwrap('b');

//=> <div id=test>
//     <p>Hello</p>
//     <p>World</p>
//   </div>

See

https://api.jquery.com/unwrap/

wrapAll()

wrapAll<T>(this, wrapper): Cheerio<T>;

Defined in: src/api/manipulation.ts

The .wrapAll() function can take any string or object that could be passed to the $() function to specify a DOM structure. This structure may be nested several levels deep, but should contain only one inmost element. The structure will be wrapped around all of the elements in the set of matched elements, as a single group.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself.

Examples

const $ = cheerio.load(
  '<div class="container"><div class="inner">First</div><div class="inner">Second</div></div>',
);
$('.inner').wrapAll("<div class='new'></div>");

//=> <div class="container">
//     <div class='new'>
//       <div class="inner">First</div>
//       <div class="inner">Second</div>
//     </div>
//   </div>

const $ = cheerio.load(
  '<span>Span 1</span><strong>Strong</strong><span>Span 2</span>',
);
const wrap = $('<div><p><em><b></b></em></p></div>');
$('span').wrapAll(wrap);

//=> <div>
//     <p>
//       <em>
//         <b>
//           <span>Span 1</span>
//           <span>Span 2</span>
//         </b>
//       </em>
//     </p>
//   </div>
//   <strong>Strong</strong>

See

https://api.jquery.com/wrapAll/

Other

cheerio

cheerio: "[cheerio object]";

Defined in: src/cheerio.ts

length

length: number = 0;

Defined in: src/cheerio.ts

Implementation of

ArrayLike.length

options

options: InternalOptions;

Defined in: src/cheerio.ts

prevObject

prevObject: Cheerio<any> | undefined;

Defined in: src/cheerio.ts

splice()

splice: {
  (start, deleteCount?): any[];
  (start, deleteCount, ...items): any[];
};

Defined in: src/cheerio.ts

Call Signature

(start, deleteCount?): any[];

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

Returns

any[]

An array containing the elements that were deleted.

Call Signature

(
   start, 
   deleteCount, ...
   items): any[];

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

Returns

any[]

An array containing the elements that were deleted.

[iterator]()

iterator: Iterator<T, any, any>;

Defined in: website/node_modules/typescript/lib/lib.es2015.iterable.d.ts

Returns

Iterator<T, any, any>

extract()

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

Defined in: src/api/extract.ts

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

Type Parameters

Parameters

Returns

ExtractedMap<M>

An object containing the extracted values.

filterArray()

filterArray<T>(
   nodes, 
   match, 
   xmlMode?, 
   root?): Element[] | T[];

Defined in: src/api/traversing.ts

Type Parameters

Parameters

Returns

Element[] | T[]

foo()

foo(this): void;

Defined in: src/cheerio.spec.ts

Parameters

Returns

void

myPlugin()

myPlugin(...args): {
  args: unknown[];
  context: Cheerio<T>;
};

Defined in: src/cheerio.spec.ts

Parameters

Returns

{
  args: unknown[];
  context: Cheerio<T>;
}

toArray()

toArray<T>(this): T[];

Defined in: src/api/traversing.ts

Retrieve all the DOM elements contained in the jQuery set as an array.

Type Parameters

Parameters

Returns

T[]

The contained items.

Example

$('li').toArray();
//=> [ {...}, {...}, {...} ]

Traversing

children()

children: <T>(this, selector?) => Cheerio<Element>;

Defined in: src/api/traversing.ts

Gets the element children of each element in the set of matched elements.

Type Parameters

Parameters

Returns

Cheerio<Element>

The children.

Example

$('#fruits').children().length;
//=> 3

$('#fruits').children('.pear').text();
//=> Pear

See

https://api.jquery.com/children/

next()

next: <T>(this, selector?) => Cheerio<Element>;

Defined in: src/api/traversing.ts

Gets the next sibling of each selected element, optionally filtered by a selector.

Type Parameters

Parameters

Returns

Cheerio<Element>

The next nodes.

Example

$('.apple').next().hasClass('orange');
//=> true

See

https://api.jquery.com/next/

nextAll()

nextAll: <T>(this, selector?) => Cheerio<Element>;

Defined in: src/api/traversing.ts

Gets all the following siblings of the each selected element, optionally filtered by a selector.

Type Parameters

Parameters

Returns

Cheerio<Element>

The next nodes.

Example

$('.apple').nextAll();
//=> [<li class="orange">Orange</li>, <li class="pear">Pear</li>]
$('.apple').nextAll('.orange');
//=> [<li class="orange">Orange</li>]

See

https://api.jquery.com/nextAll/

nextUntil()

nextUntil: <T>(this, selector?, filterSelector?) => Cheerio<Element>;

Defined in: src/api/traversing.ts

Gets all the following siblings up to but not including the element matched by the selector, optionally filtered by another selector.

Type Parameters

Parameters

Returns

Cheerio<Element>

The next nodes.

Example

$('.apple').nextUntil('.pear');
//=> [<li class="orange">Orange</li>]

See

https://api.jquery.com/nextUntil/

parent()

parent: <T>(this, selector?) => Cheerio<Element>;

Defined in: src/api/traversing.ts

Get the parent of each element in the current set of matched elements, optionally filtered by a selector.

Type Parameters

Parameters

Returns

Cheerio<Element>

The parents.

Example

$('.pear').parent().attr('id');
//=> fruits

See

https://api.jquery.com/parent/

parents()

parents: <T>(this, selector?) => Cheerio<Element>;

Defined in: src/api/traversing.ts

Get a set of parents filtered by selector of each element in the current set of match elements.

Type Parameters

Parameters

Returns

Cheerio<Element>

The parents.

Example

$('.orange').parents().length;
//=> 2
$('.orange').parents('#fruits').length;
//=> 1

See

https://api.jquery.com/parents/

parentsUntil()

parentsUntil: <T>(this, selector?, filterSelector?) => Cheerio<Element>;

Defined in: src/api/traversing.ts

Get the ancestors of each element in the current set of matched elements, up to but not including the element matched by the selector, DOM node, or cheerio object.

Type Parameters

Parameters

Returns

Cheerio<Element>

The parents.

Example

$('.orange').parentsUntil('#food').length;
//=> 1

See

https://api.jquery.com/parentsUntil/

prev()

prev: <T>(this, selector?) => Cheerio<Element>;

Defined in: src/api/traversing.ts

Gets the previous sibling of each selected element optionally filtered by a selector.

Type Parameters

Parameters

Returns

Cheerio<Element>

The previous nodes.

Example

$('.orange').prev().hasClass('apple');
//=> true

See

https://api.jquery.com/prev/

prevAll()

prevAll: <T>(this, selector?) => Cheerio<Element>;

Defined in: src/api/traversing.ts

Gets all the preceding siblings of each selected element, optionally filtered by a selector.

Type Parameters

Parameters

Returns

Cheerio<Element>

The previous nodes.

Example

$('.pear').prevAll();
//=> [<li class="orange">Orange</li>, <li class="apple">Apple</li>]

$('.pear').prevAll('.orange');
//=> [<li class="orange">Orange</li>]

See

https://api.jquery.com/prevAll/

prevUntil()

prevUntil: <T>(this, selector?, filterSelector?) => Cheerio<Element>;

Defined in: src/api/traversing.ts

Gets all the preceding siblings up to but not including the element matched by the selector, optionally filtered by another selector.

Type Parameters

Parameters

Returns

Cheerio<Element>

The previous nodes.

Example

$('.pear').prevUntil('.apple');
//=> [<li class="orange">Orange</li>]

See

https://api.jquery.com/prevUntil/

siblings()

siblings: <T>(this, selector?) => Cheerio<Element>;

Defined in: src/api/traversing.ts

Get the siblings of each element (excluding the element) in the set of matched elements, optionally filtered by a selector.

Type Parameters

Parameters

Returns

Cheerio<Element>

The siblings.

Example

$('.pear').siblings().length;
//=> 2

$('.pear').siblings('.orange').length;
//=> 1

See

https://api.jquery.com/siblings/

add()

add<S, T>(
   this, 
   other, 
context?): Cheerio<S | T>;

Defined in: src/api/traversing.ts

Add elements to the set of matched elements.

Type Parameters

Parameters

Returns

Cheerio<S | T>

The combined set.

Example

$('.apple').add('.orange').length;
//=> 2

See

https://api.jquery.com/add/

addBack()

addBack<T>(this, selector?): Cheerio<AnyNode>;

Defined in: src/api/traversing.ts

Add the previous set of elements on the stack to the current set, optionally filtered by a selector.

Type Parameters

Parameters

Returns

Cheerio<AnyNode>

The combined set.

Example

$('li').eq(0).addBack('.orange').length;
//=> 2

See

https://api.jquery.com/addBack/

closest()

closest<T>(this, selector?): Cheerio<AnyNode>;

Defined in: src/api/traversing.ts

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.

Type Parameters

Parameters

Returns

Cheerio<AnyNode>

The closest nodes.

Example

$('.orange').closest();
//=> []

$('.orange').closest('.apple');
// => []

$('.orange').closest('li');
//=> [<li class="orange">Orange</li>]

$('.orange').closest('#fruits');
//=> [<ul id="fruits"> ... </ul>]

See

https://api.jquery.com/closest/

contents()

contents<T>(this): Cheerio<AnyNode>;

Defined in: src/api/traversing.ts

Gets the children of each element in the set of matched elements, including text and comment nodes.

Type Parameters

Parameters

Returns

Cheerio<AnyNode>

The children.

Example

$('#fruits').contents().length;
//=> 3

See

https://api.jquery.com/contents/

each()

each<T>(this, fn): Cheerio<T>;

Defined in: src/api/traversing.ts

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.

Type Parameters

Parameters

Returns

Cheerio<T>

The instance itself, useful for chaining.

Example

const fruits = [];

$('li').each(function (i, elem) {
  fruits[i] = $(this).text();
});

fruits.join(', ');
//=> Apple, Orange, Pear

See

https://api.jquery.com/each/

end()

end<T>(this): Cheerio<AnyNode>;

Defined in: src/api/traversing.ts

End the most recent filtering operation in the current chain and return the set of matched elements to its previous state.

Type Parameters

Parameters

Returns

Cheerio<AnyNode>

The previous state of the set of matched elements.

Example

$('li').eq(0).end().length;
//=> 3

See

https://api.jquery.com/end/

eq()

eq<T>(this, i): Cheerio<T>;

Defined in: src/api/traversing.ts

Reduce the set of matched elements to the one at the specified index. Use .eq(-i) to count backwards from the last selected element.

Type Parameters

Parameters

Returns

Cheerio<T>

The element at the ith position.

Example

$('li').eq(0).text();
//=> Apple

$('li').eq(-1).text();
//=> Pear

See

https://api.jquery.com/eq/

filter()

Call Signature

filter<T, S>(this, match): Cheerio<S>;

Defined in: src/api/traversing.ts

Iterates over a cheerio object, reducing the set of selector elements to those that match the selector or pass the function’s test.

This is the definition for using type guards; have a look below for other ways to invoke this method. The function is executed in the context of the selected element, so this refers to the current element.

Type Parameters

Parameters

Returns

Cheerio<S>

The filtered collection.

Example

$('li')
  .filter(function (i, el) {
    // this === el
    return $(this).attr('class') === 'orange';
  })
  .attr('class'); //=> orange

See

https://api.jquery.com/filter/

Call Signature

filter<T, S>(this, match): Cheerio<S extends string ? Element : T>;

Defined in: src/api/traversing.ts

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.

Type Parameters

Parameters

Returns

Cheerio<S extends string ? Element : T>

The filtered collection.

Examples

$('li').filter('.orange').attr('class');
//=> orange

$('li')
  .filter(function (i, el) {
    // this === el
    return $(this).attr('class') === 'orange';
  })
  .attr('class'); //=> orange

See

https://api.jquery.com/filter/

find()

find<T>(this, selectorOrHaystack?): Cheerio<Element>;

Defined in: src/api/traversing.ts

Get the descendants of each element in the current set of matched elements, filtered by a selector, jQuery object, or element.

Type Parameters

Parameters

Returns

Cheerio<Element>

The found elements.

Example

$('#fruits').find('li').length;
//=> 3
$('#fruits').find($('.apple')).length;
//=> 1

See

https://api.jquery.com/find/

first()

first<T>(this): Cheerio<T>;

Defined in: src/api/traversing.ts

Will select the first element of a cheerio object.

Type Parameters

Parameters

Returns

Cheerio<T>

The first element.

Example

$('#fruits').children().first().text();
//=> Apple

See

https://api.jquery.com/first/

get()

Call Signature

get<T>(this, i): T | undefined;

Defined in: src/api/traversing.ts

Retrieve one of the elements matched by the Cheerio object, at the ith position.

Type Parameters

Parameters

Returns

T | undefined

The element at the ith position.

Example

$('li').get(0).tagName;
//=> li

See

https://api.jquery.com/get/

Call Signature

get<T>(this): T[];

Defined in: src/api/traversing.ts

Retrieve all elements matched by the Cheerio object, as an array.

Type Parameters

Parameters

Returns

T[]

All elements matched by the Cheerio object.

Example

$('li').get().length;
//=> 3

See

https://api.jquery.com/get/

has()

has(this, selectorOrHaystack): Cheerio<AnyNode>;

Defined in: src/api/traversing.ts

Filters the set of matched elements to only those which have the given DOM element as a descendant or which have a descendant that matches the given selector. Equivalent to .filter(':has(selector)').

Parameters

Returns

Cheerio<AnyNode>

The filtered collection.

Examples

$('ul').has('.pear').attr('id');
//=> fruits

$('ul').has($('.pear')[0]).attr('id');
//=> fruits

See

https://api.jquery.com/has/

index()

index<T>(this, selectorOrNeedle?): number;

Defined in: src/api/traversing.ts

Search for a given element from among the matched elements.

Type Parameters

Parameters

Returns

number

The index of the element.

Example

$('.pear').index();
//=> 2 $('.orange').index('li');
//=> 1
$('.apple').index($('#fruit, li'));
//=> 1

See

https://api.jquery.com/index/

is()

is<T>(this, selector?): boolean;

Defined in: src/api/traversing.ts

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.

Type Parameters

Parameters

Returns

boolean

Whether or not the selector matches an element of the instance.

See

https://api.jquery.com/is/

last()

last<T>(this): Cheerio<T>;

Defined in: src/api/traversing.ts

Will select the last element of a cheerio object.

Type Parameters

Parameters

Returns

Cheerio<T>

The last element.

Example

$('#fruits').children().last().text();
//=> Pear

See

https://api.jquery.com/last/

map()

map<T, M>(this, fn): Cheerio<M>;

Defined in: src/api/traversing.ts

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.

Type Parameters

Parameters

Returns

Cheerio<M>

The mapped elements, wrapped in a Cheerio collection.

Example

$('li')
  .map(function (i, el) {
    // this === el
    return $(this).text();
  })
  .toArray()
  .join(' ');
//=> "apple orange pear"

See

https://api.jquery.com/map/

not()

not<T>(this, match): Cheerio<T>;

Defined in: src/api/traversing.ts

Remove elements from the set of matched elements. Given a Cheerio object that represents a set of DOM elements, the .not() method constructs a new Cheerio object from a subset of the matching elements. The supplied selector is tested against each element; the elements that don’t match the selector will be included in the result.

The .not() method can take a function as its argument in the same way that .filter() does. Elements for which the function returns true are excluded from the filtered set; all other elements are included.

Type Parameters

Parameters

Returns

Cheerio<T>

The filtered collection.

Examples

$('li').not('.apple').length;
//=> 2

$('li').not(function (i, el) {
  // this === el
  return $(this).attr('class') === 'orange';
}).length; //=> 2

See

https://api.jquery.com/not/

slice()

slice<T>(
   this, 
   start?, 
end?): Cheerio<T>;

Defined in: src/api/traversing.ts

Gets the elements matching the specified range (0-based position).

Type Parameters

Parameters

Returns

Cheerio<T>

The elements matching the specified range.

Example

$('li').slice(1).eq(0).text();
//=> 'Orange'

$('li').slice(1, 2).length;
//=> 1

See

https://api.jquery.com/slice/