chore(types): Add wrapAll (#1740)

cheeriojs · Feb 16, 2021 · b360762 · b360762
1 parent 1a86118
commit b360762
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 4 deletions.
diff --git a/lib/api/manipulation.js b/lib/api/manipulation.js
@@ -447,8 +447,8 @@ exports.unwrap = function (selector) {
  * // </div>
  * // <strong>Strong</strong>
  *
- * @param {Cheerio} wrapper - The DOM structure to wrap around all matched
- * elements in the selection.
+ * @param {Cheerio | string | Element | Element[] | Function} wrapper - The DOM
+ * structure to wrap around all matched elements in the selection.
  * @see {@link https://api.jquery.com/wrapAll/}
  * @returns {Cheerio} The instance itself.
  */

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -3,6 +3,7 @@ import { ParserOptions } from 'htmlparser2';
 
 declare namespace cheerio {
  type AttrFunction = (this: Element, i: number, currentValue: string) => any;
+ type WrapFunction = (this: Element) => any;
 
  interface Cheerio {
  // Document References
@@ -194,6 +195,10 @@ declare namespace cheerio {
  wrap(content: Document): Cheerio;
  wrap(content: Cheerio): Cheerio;
 
+ wrapAll(
+ wrapper: Cheerio | string | Element | Element[] | WrapFunction
+ ): Cheerio;
+
  css(propertyName: string): string;
  css(propertyNames: string[]): string[];
  css(propertyName: string, value: string): Cheerio;
@@ -270,11 +275,11 @@ declare namespace cheerio {
  interface CheerioAPI extends Root {
  version: string;
  load(
- html: string | { toString(): string },
+ html: string | Buffer | { toString(): string },
  options?: CheerioParserOptions | null,
  isDocument?: boolean
  ): Root;
- load(element: Element, options?: CheerioParserOptions): Root;
+ load(element: Element | Element[], options?: CheerioParserOptions): Root;
  }
 }
 

diff --git a/types/index.test-d.ts b/types/index.test-d.ts
@@ -316,6 +316,14 @@ $el.text('text');
 // .wrap( content )
 $el.wrap($('<div class="red-fruit"></div>')).html();
 
+// .wrapAll( wrapper )
+$el.wrapAll($('<div class="red-fruit"></div>'));
+$el.wrapAll($('<div class="red-fruit"></div>').get());
+$el.wrapAll('<div class="red-fruit"></div>');
+$el.wrapAll(function () {
+ return '<div class="red-fruit"></div>';
+});
+
 // .css
 $el.css('width');
 $el.css(['width', 'height']);