• Backend Script API
• <internal>
• CheerioAPI

Interface CheerioAPI

interface CheerioAPI {
version: string;
contains(container: Element, contained: Element): boolean;
html(options?: CheerioParserOptions): string;
html(
dom: string | Element | Cheerio,
options?: CheerioParserOptions,
): string;
load(
html: string | Buffer<ArrayBufferLike>,
options?: CheerioParserOptions,
): Root;
load(element: Element | Element[], options?: CheerioParserOptions): Root;
parseHTML(
data: string,
context?: null | Document,
keepScripts?: boolean,
): Document[];
root(): Cheerio;
xml(dom?: string | Element | Cheerio): string;
(selector: string): Cheerio;
(selector: string, context: string): Cheerio;
(selector: string, context: Element): Cheerio;
(selector: string, context: Element[]): Cheerio;
(selector: string, context: Cheerio): Cheerio;
(selector: string, context: string, root: string): Cheerio;
(selector: string, context: Element, root: string): Cheerio;
(selector: string, context: Element[], root: string): Cheerio;
(selector: string, context: Cheerio, root: string): Cheerio;
(selector: any): Cheerio;
}

Hierarchy (View Summary)

• Root

  • CheerioAPI

CheerioAPI(selector: string): Cheerio

Parameters

• selector: string

Returns Cheerio

CheerioAPI(selector: string, context: string): Cheerio

Parameters

• selector: string
• context: string

Returns Cheerio

CheerioAPI(selector: string, context: Element): Cheerio

Parameters

• selector: string
• context: Element

Returns Cheerio

CheerioAPI(selector: string, context: Element[]): Cheerio

Parameters

• selector: string
• context: Element[]

Returns Cheerio

CheerioAPI(selector: string, context: Cheerio): Cheerio

Parameters

• selector: string
• context: Cheerio

Returns Cheerio

CheerioAPI(selector: string, context: string, root: string): Cheerio

Parameters

• selector: string
• context: string
• root: string

Returns Cheerio

CheerioAPI(selector: string, context: Element, root: string): Cheerio

Parameters

• selector: string
• context: Element
• root: string

Returns Cheerio

CheerioAPI(selector: string, context: Element[], root: string): Cheerio

Parameters

• selector: string
• context: Element[]
• root: string

Returns Cheerio

CheerioAPI(selector: string, context: Cheerio, root: string): Cheerio

Parameters

• selector: string
• context: Cheerio
• root: string

Returns Cheerio

CheerioAPI(selector: any): Cheerio

Parameters

• selector: any

Returns Cheerio

Index

Properties

version

Methods

containshtmlloadparseHTMLrootxml

Properties

version

version: string

Methods

contains

contains(container: Element, contained: Element): boolean

Parameters

• container: Element
• contained: Element

Returns boolean

html

html(options?: CheerioParserOptions): string

Parameters

• Optionaloptions: CheerioParserOptions

Returns string

html(dom: string | Element | Cheerio, options?: CheerioParserOptions): string

Parameters

• dom: string | Element | Cheerio
• Optionaloptions: CheerioParserOptions

Returns string

load

load(
html: string | Buffer<ArrayBufferLike>,
options?: CheerioParserOptions,
): Root

Parameters

• html: string | Buffer<ArrayBufferLike>
• Optionaloptions: CheerioParserOptions

Returns Root

load(element: Element | Element[], options?: CheerioParserOptions): Root

Parameters

• element: Element | Element[]
• Optionaloptions: CheerioParserOptions

Returns Root

parseHTML

parseHTML(
data: string,
context?: null | Document,
keepScripts?: boolean,
): Document[]

Parameters

• data: string
• Optionalcontext: null | Document
• OptionalkeepScripts: boolean

Returns Document[]

root

root(): Cheerio

Returns Cheerio

xml

xml(dom?: string | Element | Cheerio): string

Parameters

• Optionaldom: string | Element | Cheerio

Returns string

Settings

Member Visibility

• Protected
• Inherited
• External

ThemeOSLightDark

On This Page

Properties version Methods containshtmlloadparseHTMLrootxml