docs/Script API/interfaces/Backend_Script_API._internal_.Cheerio.html
interface Cheerio {
cheerio: string;
length: number;
"[iterator]"(): IterableIterator<Element>;
add(selectorOrHtml: string): Cheerio;
add(selector: string, context: Document): Cheerio;
add(element: Element): Cheerio;
add(elements: Element[]): Cheerio;
add(selection: Cheerio): Cheerio;
addBack(): Cheerio;
addBack(filter: string): Cheerio;
addClass(classNames: string): Cheerio;
after(content: string, ...contents: any[]): Cheerio;
after(content: Document, ...contents: any[]): Cheerio;
after(content: Document[], ...contents: any[]): Cheerio;
after(content: Cheerio, ...contents: any[]): Cheerio;
append(content: string, ...contents: any[]): Cheerio;
append(content: Document, ...contents: any[]): Cheerio;
append(content: Document[], ...contents: any[]): Cheerio;
append(content: Cheerio, ...contents: any[]): Cheerio;
appendTo(target: Cheerio): Cheerio;
attr(): { [attr: string]: string };
attr(name: string): undefined | string;
attr(name: string, value: AttrFunction): Cheerio;
attr(name: string, value: string): Cheerio;
attr(map: { [key: string]: any }): Cheerio;
before(content: string, ...contents: any[]): Cheerio;
before(content: Document, ...contents: any[]): Cheerio;
before(content: Document[], ...contents: any[]): Cheerio;
before(content: Cheerio, ...contents: any[]): Cheerio;
children(selector?: string): Cheerio;
clone(): Cheerio;
closest(): Cheerio;
closest(selector: string): Cheerio;
contents(): Cheerio;
css(propertyName?: string): string;
css(propertyNames: string[]): string[];
css(propertyName: string, value: string): Cheerio;
css(propertyName: string, value: number): Cheerio;
css(
propertyName: string,
func: (index: number, value: string) => string,
): Cheerio;
css(
propertyName: string,
func: (index: number, value: string) => number,
): Cheerio;
css(properties: Object): Cheerio;
data(): any;
data(name: string): any;
data(name: string, value: any): any;
each(func: (index: number, element: Element) => any): Cheerio;
empty(): Cheerio;
end(): Cheerio;
eq(index: number): Cheerio;
filter(selector: string): Cheerio;
filter(selection: Cheerio): Cheerio;
filter(element: Element): Cheerio;
filter(elements: Element[]): Cheerio;
filter(func: (index: number, element: Element) => boolean): Cheerio;
find(selector: string): Cheerio;
find(element: Cheerio): Cheerio;
first(): Cheerio;
get(): any[];
get(index: number): any;
has(selector: string): Cheerio;
has(element: Element): Cheerio;
hasClass(className: string): boolean;
html(): null | string;
html(html: string): Cheerio;
index(): number;
index(selector: string): number;
index(selection: Cheerio): number;
insertAfter(content: string): Cheerio;
insertAfter(content: Document): Cheerio;
insertAfter(content: Cheerio): Cheerio;
insertBefore(content: string): Cheerio;
insertBefore(content: Document): Cheerio;
insertBefore(content: Cheerio): Cheerio;
is(selector: string): boolean;
is(element: Element): boolean;
is(element: Element[]): boolean;
is(selection: Cheerio): boolean;
is(func: (index: number, element: Element) => boolean): boolean;
last(): Cheerio;
map(func: (index: number, element: Element) => any): Cheerio;
next(selector?: string): Cheerio;
nextAll(): Cheerio;
nextAll(selector: string): Cheerio;
nextUntil(selector?: string, filter?: string): Cheerio;
nextUntil(element: Element, filter?: string): Cheerio;
nextUntil(element: Cheerio, filter?: string): Cheerio;
not(selector: string): Cheerio;
not(selection: Cheerio): Cheerio;
not(element: Element): Cheerio;
not(func: (index: number, element: Element) => boolean): Cheerio;
parent(selector?: string): Cheerio;
parents(selector?: string): Cheerio;
parentsUntil(selector?: string, filter?: string): Cheerio;
parentsUntil(element: Element, filter?: string): Cheerio;
parentsUntil(element: Cheerio, filter?: string): Cheerio;
prepend(content: string, ...contents: any[]): Cheerio;
prepend(content: Document, ...contents: any[]): Cheerio;
prepend(content: Document[], ...contents: any[]): Cheerio;
prepend(content: Cheerio, ...contents: any[]): Cheerio;
prependTo(target: Cheerio): Cheerio;
prev(selector?: string): Cheerio;
prevAll(): Cheerio;
prevAll(selector: string): Cheerio;
prevUntil(selector?: string, filter?: string): Cheerio;
prevUntil(element: Element, filter?: string): Cheerio;
prevUntil(element: Cheerio, filter?: string): Cheerio;
prop(name: string): any;
prop(name: string, value: any): Cheerio;
remove(selector?: string): Cheerio;
removeAttr(name: string): Cheerio;
removeClass(): Cheerio;
removeClass(className: string): Cheerio;
removeClass(func: (index: number, className: string) => string): Cheerio;
replaceWith(content: string): Cheerio;
replaceWith(content: Element): Cheerio;
replaceWith(content: Element[]): Cheerio;
replaceWith(content: Cheerio): Cheerio;
replaceWith(content: () => Cheerio): Cheerio;
serialize(): string;
serializeArray(): { name: string; value: string }[];
siblings(selector?: string): Cheerio;
slice(start: number, end?: number): Cheerio;
text(): string;
text(text: string): Cheerio;
toArray(): Element[];
toggleClass(className: string): Cheerio;
toggleClass(className: string, toggleSwitch: boolean): Cheerio;
toggleClass(toggleSwitch?: boolean): Cheerio;
toggleClass(
func: (
index: number,
className: string,
toggleSwitch: boolean,
) => string,
toggleSwitch?: boolean,
): Cheerio;
val(): string;
val(value: string): Cheerio;
wrap(content: string): Cheerio;
wrap(content: Document): Cheerio;
wrap(content: Cheerio): Cheerio;
index: number: Element;
}
[iterator]addaddBackaddClassafterappendappendToattrbeforechildrencloneclosestcontentscssdataeachemptyendeqfilterfindfirstgethashasClasshtmlindexinsertAfterinsertBeforeislastmapnextnextAllnextUntilnotparentparentsparentsUntilprependprependToprevprevAllprevUntilpropremoveremoveAttrremoveClassreplaceWithserializeserializeArraysiblingsslicetexttoArraytoggleClassvalwrap
cheerio: string
length: number
"[iterator]"(): IterableIterator<Element>
add(selectorOrHtml: string): Cheerio
add(selector: string, context: Document): Cheerio
add(element: Element): Cheerio
add(elements: Element[]): Cheerio
add(selection: Cheerio): Cheerio
addBack(): Cheerio
addBack(filter: string): Cheerio
addClass(classNames: string): Cheerio
after(content: string, ...contents: any[]): Cheerio
after(content: Document, ...contents: any[]): Cheerio
after(content: Document[], ...contents: any[]): Cheerio
after(content: Cheerio, ...contents: any[]): Cheerio
append(content: string, ...contents: any[]): Cheerio
append(content: Document, ...contents: any[]): Cheerio
append(content: Document[], ...contents: any[]): Cheerio
append(content: Cheerio, ...contents: any[]): Cheerio
appendTo(target: Cheerio): Cheerio
attr(): { [attr: string]: string }
attr(name: string): undefined | string
attr(name: string, value: AttrFunction): Cheerio
attr(name: string, value: string): Cheerio
attr(map: { [key: string]: any }): Cheerio
before(content: string, ...contents: any[]): Cheerio
before(content: Document, ...contents: any[]): Cheerio
before(content: Document[], ...contents: any[]): Cheerio
before(content: Cheerio, ...contents: any[]): Cheerio
children(selector?: string): Cheerio
Optionalselector: stringclone(): Cheerio
closest(): Cheerio
closest(selector: string): Cheerio
contents(): Cheerio
css(propertyName?: string): string
OptionalpropertyName: stringcss(propertyNames: string[]): string[]
css(propertyName: string, value: string): Cheerio
css(propertyName: string, value: number): Cheerio
css(
propertyName: string,
func: (index: number, value: string) => string,
): Cheerio
css(
propertyName: string,
func: (index: number, value: string) => number,
): Cheerio
css(properties: Object): Cheerio
data(): any
data(name: string): any
data(name: string, value: any): any
each(func: (index: number, element: Element) => any): Cheerio
empty(): Cheerio
end(): Cheerio
eq(index: number): Cheerio
filter(selector: string): Cheerio
filter(selection: Cheerio): Cheerio
filter(element: Element): Cheerio
filter(elements: Element[]): Cheerio
filter(func: (index: number, element: Element) => boolean): Cheerio
find(selector: string): Cheerio
find(element: Cheerio): Cheerio
first(): Cheerio
get(): any[]
get(index: number): any
has(selector: string): Cheerio
has(element: Element): Cheerio
hasClass(className: string): boolean
html(): null | string
html(html: string): Cheerio
index(): number
index(selector: string): number
index(selection: Cheerio): number
insertAfter(content: string): Cheerio
insertAfter(content: Document): Cheerio
insertAfter(content: Cheerio): Cheerio
insertBefore(content: string): Cheerio
insertBefore(content: Document): Cheerio
insertBefore(content: Cheerio): Cheerio
is(selector: string): boolean
is(element: Element): boolean
is(element: Element[]): boolean
is(selection: Cheerio): boolean
is(func: (index: number, element: Element) => boolean): boolean
last(): Cheerio
map(func: (index: number, element: Element) => any): Cheerio
next(selector?: string): Cheerio
Optionalselector: stringnextAll(): Cheerio
nextAll(selector: string): Cheerio
nextUntil(selector?: string, filter?: string): Cheerio
Optionalselector: stringOptionalfilter: stringnextUntil(element: Element, filter?: string): Cheerio
Optionalfilter: stringnextUntil(element: Cheerio, filter?: string): Cheerio
Optionalfilter: stringnot(selector: string): Cheerio
not(selection: Cheerio): Cheerio
not(element: Element): Cheerio
not(func: (index: number, element: Element) => boolean): Cheerio
parent(selector?: string): Cheerio
Optionalselector: stringparents(selector?: string): Cheerio
Optionalselector: stringparentsUntil(selector?: string, filter?: string): Cheerio
Optionalselector: stringOptionalfilter: stringparentsUntil(element: Element, filter?: string): Cheerio
Optionalfilter: stringparentsUntil(element: Cheerio, filter?: string): Cheerio
Optionalfilter: stringprepend(content: string, ...contents: any[]): Cheerio
prepend(content: Document, ...contents: any[]): Cheerio
prepend(content: Document[], ...contents: any[]): Cheerio
prepend(content: Cheerio, ...contents: any[]): Cheerio
prependTo(target: Cheerio): Cheerio
prev(selector?: string): Cheerio
Optionalselector: stringprevAll(): Cheerio
prevAll(selector: string): Cheerio
prevUntil(selector?: string, filter?: string): Cheerio
Optionalselector: stringOptionalfilter: stringprevUntil(element: Element, filter?: string): Cheerio
Optionalfilter: stringprevUntil(element: Cheerio, filter?: string): Cheerio
Optionalfilter: stringprop(name: string): any
prop(name: string, value: any): Cheerio
remove(selector?: string): Cheerio
Optionalselector: stringremoveAttr(name: string): Cheerio
removeClass(): Cheerio
removeClass(className: string): Cheerio
removeClass(func: (index: number, className: string) => string): Cheerio
replaceWith(content: string): Cheerio
replaceWith(content: Element): Cheerio
replaceWith(content: Element[]): Cheerio
replaceWith(content: Cheerio): Cheerio
replaceWith(content: () => Cheerio): Cheerio
serialize(): string
serializeArray(): { name: string; value: string }[]
siblings(selector?: string): Cheerio
Optionalselector: stringslice(start: number, end?: number): Cheerio
Optionalend: numbertext(): string
text(text: string): Cheerio
toArray(): Element[]
toggleClass(className: string): Cheerio
toggleClass(className: string, toggleSwitch: boolean): Cheerio
toggleClass(toggleSwitch?: boolean): Cheerio
OptionaltoggleSwitch: booleantoggleClass(
func: (
index: number,
className: string,
toggleSwitch: boolean,
) => string,
toggleSwitch?: boolean,
): Cheerio
OptionaltoggleSwitch: booleanval(): string
val(value: string): Cheerio
wrap(content: string): Cheerio
wrap(content: Document): Cheerio
wrap(content: Cheerio): Cheerio
Member Visibility
ThemeOSLightDark
Properties cheeriolength Methods [iterator]addaddBackaddClassafterappendappendToattrbeforechildrencloneclosestcontentscssdataeachemptyendeqfilterfindfirstgethashasClasshtmlindexinsertAfterinsertBeforeislastmapnextnextAllnextUntilnotparentparentsparentsUntilprependprependToprevprevAllprevUntilpropremoveremoveAttrremoveClassreplaceWithserializeserializeArraysiblingsslicetexttoArraytoggleClassvalwrap