メインコンテンツへスキップ

クラス: abstract Cheerio<T>

cheerio クラスはライブラリの中心となるクラスです。要素の集合をラップし、その集合を走査、変更、操作するための API を提供します。

ドキュメントを読み込むと、ドキュメントのルート要素にバインドされた Cheerio クラスが返されます。このクラスは、ドキュメントをクエリする（$('selector') を呼び出す）ときにインスタンス化されます。

例​

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

拡張​

型パラメータ​

• T

実装​

  • ArrayLike<T>

インデックス可能​

[index: number]: T

属性​

addClass()​

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

一致したすべての要素にクラスを追加します。functionも受け入れます。

型パラメータ​

• T extends AnyNode

• R extends ArrayLike<T>

パラメータ​

• this: R

• value?: string | (this, i, className) => undefined | string

新しいクラスの名前。

戻り値​

R

インスタンス自体。

例​

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

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

参照​

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

定義元​

src/api/attributes.ts:933

attr()​

attr(this, name)​

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

属性を取得するメソッド。一致した集合の最初の要素のみの属性値を取得します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• name: string

属性の名前。

戻り値​

string | undefined

属性の値。

例​
$('ul').attr('id');
//=> fruits
参照​

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

定義元​

src/api/attributes.ts:114

attr(this)​

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

一致した集合の最初の要素のすべての属性とその値を取得するメソッド。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

戻り値​

Record<string, string> | undefined

属性の値。

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

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

定義元​

src/api/attributes.ts:133

attr(this, name, value)​

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

属性を設定するためのメソッド。一致した集合の最初の要素のみの属性値を設定します。属性の値を null に設定すると、その属性が削除されます。map および function を渡すこともできます。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• name: string

属性の名前。

• value?: null | string | (this, i, attrib) => null | string

属性の新しい値。

戻り値​

Cheerio<T>

インスタンス自体。

例​
$('.apple').attr('id', 'favorite').html();
//=> <li class="apple" id="favorite">Apple</li>
参照​

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

定義元​

src/api/attributes.ts:154

attr(this, values)​

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

複数の属性を一度に設定するためのメソッド。一致した集合の最初の要素のみの属性値を設定します。属性の値を null に設定すると、その属性が削除されます。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• values: Record<string, null | string>

属性の名前と値のマップ。

戻り値​

Cheerio<T>

インスタンス自体。

例​
$('.apple').attr({ id: 'favorite' }).html();
//=> <li class="apple" id="favorite">Apple</li>
参照​

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

定義元​

src/api/attributes.ts:179

data()​

data(this, name)​

data<T>(this, name): unknown | undefined

一致した集合の最初の要素のみのデータ属性を取得するメソッド。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• name: string

データ属性の名前。

戻り値​

unknown | undefined

データ属性の値。属性が存在しない場合は undefined。

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

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

定義元​

src/api/attributes.ts:629

data(this)​

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

一致した集合の最初の要素のみの、要素のすべてのデータ属性を取得するメソッド。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

戻り値​

Record<string, unknown>

すべてのデータ属性を持つマップ。

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

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

定義元​

src/api/attributes.ts:648

data(this, name, value)​

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

マッチしたセットの最初の要素に対してのみ、データ属性を設定するためのメソッド。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• name: string

データ属性の名前。

• value: unknown

新しい値。

戻り値​

Cheerio<T>

インスタンス自体。

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

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

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

定義元​

src/api/attributes.ts:670

data(this, values)​

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

マッチしたセットの最初の要素に対してのみ、複数のデータ属性を一度に設定するためのメソッド。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• values: Record<string, unknown>

名前と値のマップ。

戻り値​

Cheerio<T>

インスタンス自体。

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

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

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

定義元​

src/api/attributes.ts:693

hasClass()​

hasClass<T>(this, className): boolean

マッチした要素のいずれかが、指定されたclassNameを持っているかを確認します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• className: string

クラスの名前。

戻り値​

boolean

要素が指定されたclassNameを持っているかどうかを示します。

例​

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

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

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

参照​

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

定義元​

src/api/attributes.ts:890

prop()​

prop(this, name)​

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

プロパティを取得および設定するためのメソッド。マッチしたセットの最初の要素に対してのみプロパティの値を取得します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• name: "tagName" | "nodeName"

プロパティの名前。

戻り値​

string | undefined

valueが指定されている場合はインスタンス自体、それ以外の場合はプロパティの値。

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

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

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

定義元​

src/api/attributes.ts:293

prop(this, name)​

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

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• name: "innerText" | "outerHTML" | "textContent" | "innerHTML"

戻り値​

string | null

定義元​

src/api/attributes.ts:297

prop(this, name)​

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

解析されたCSSスタイルオブジェクトを取得します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• name: "style"

プロパティの名前。

戻り値​

StyleProp | undefined

スタイルオブジェクト、または要素にstyle属性がない場合はundefined。

定義元​

src/api/attributes.ts:308

prop(this, name)​

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

サポートされている要素のhrefまたはsrcを解決します。baseURIオプションが設定されている必要があり、グローバルなURLオブジェクトが環境の一部である必要があります。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• name: "href" | "src"

プロパティの名前。

戻り値​

string | undefined

解決されたURL、または要素がサポートされていない場合はundefined。

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

src/api/attributes.ts:326

prop(this, name)​

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

要素のプロパティを取得します。

型パラメータ​

• T extends AnyNode

• K extends keyof Element

パラメータ​

• this: Cheerio<T>

• name: K

プロパティの名前。

戻り値​

Element[K]

プロパティの値。

定義元​

src/api/attributes.ts:336

prop(this, name, value)​

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

要素のプロパティを設定します。

型パラメータ​

• T extends AnyNode

• K extends keyof Element

パラメータ​

• this: Cheerio<T>

• name: K

プロパティの名前。

• value: Element[K] | (this, i, prop) => undefined | null | string | number | Record<string, string> | TagSourceCodeLocation | Document | Element | CDATA | Text | Comment | ProcessingInstruction | ChildNode[] | object | Attribute[] | <T>(this, recursive?) => T

プロパティに設定する値。

戻り値​

Cheerio<T>

インスタンス自体。

定義元​

src/api/attributes.ts:347

prop(this, map)​

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

要素の複数のプロパティを設定します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• map: Record<string, undefined | null | string | number | boolean | Record<string, string> | TagSourceCodeLocation | Document | Element | CDATA | Text | Comment | ProcessingInstruction | ChildNode[] | object | Attribute[] | <T>(this, recursive?) => T>

設定するプロパティのオブジェクト。

戻り値​

Cheerio<T>

インスタンス自体。

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

src/api/attributes.ts:369

prop(this, name, value)​

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

要素のプロパティを設定します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• name: string

プロパティの名前。

• value: null | string | boolean | (this, i, prop) => string | boolean

プロパティに設定する値。

戻り値​

Cheerio<T>

インスタンス自体。

定義元​

src/api/attributes.ts:380

prop(this, name)​

prop<T>(this, name): string

要素のプロパティを取得します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• name: string

プロパティの名前。

戻り値​

string

プロパティの値。

定義元​

src/api/attributes.ts:395

removeAttr()​

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

nameで属性を削除するメソッド。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• name: string

属性の名前。

戻り値​

Cheerio<T>

インスタンス自体。

例​

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

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

参考​

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

定義元​

src/api/attributes.ts:854

removeClass()​

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

選択した要素から、1つまたは複数のスペースで区切られたクラスを削除します。classNameが定義されていない場合は、すべてのクラスが削除されます。functionも受け付けます。

型パラメータ​

• T extends AnyNode

• R extends ArrayLike<T>

パラメータ​

• this: R

• name?: string | (this, i, className) => undefined | string

クラスの名前。指定しない場合は、すべての要素を削除します。

戻り値​

R

インスタンス自体。

例​

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

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

参考​

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

定義元​

src/api/attributes.ts:1001

toggleClass()​

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

クラスの存在またはスイッチ引数の値に応じて、一致する要素にクラスを追加または削除します。functionも受け付けます。

型パラメータ​

• T extends AnyNode

• R extends ArrayLike<T>

パラメータ​

• this: R

• value?: string | (this, i, className, stateVal?) => string

クラスの名前。関数も使用できます。

• stateVal?: boolean

クラスの状態が指定されている場合。

戻り値​

R

インスタンス自体。

例​

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

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

参考​

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

定義元​

src/api/attributes.ts:1072

val()​

val(this)​

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

input、select、およびtextareaの値を取得するためのメソッド。注：mapとfunctionのサポートはまだ追加されていません。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

戻り値​

string | undefined | string[]

値。

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

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

定義元​

src/api/attributes.ts:743

val(this, value)​

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

input、select、およびtextareaの値を設定するためのメソッド。注：mapとfunctionのサポートはまだ追加されていません。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• value: string | string[]

新しい値。

戻り値​

Cheerio<T>

インスタンス自体。

例​
$('input[type="text"]').val('test').html();
//=> <input type="text" value="test"/>
参考​

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

定義元​

src/api/attributes.ts:762

CSS​

css()​

一致するすべての要素に複数のCSSプロパティを設定します。

パラメーター​

プロパティの名前。

パラメーター​

新しい値。

参考​

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

css(this, names)​

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

一致する要素のセットの最初の要素のスタイルプロパティの値を取得します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• names?: string[]

オプションで、対象となるプロパティの名前。

戻り値​

Record<string, string> | undefined

インスタンス自体。

すべてのスタイルプロパティのマップ。

パラメーター​

プロパティの名前。

パラメーター​

新しい値。

参考​

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

参考​

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

定義元​

src/api/css.ts:14

css(this, name)​

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

一致する要素のセットの最初の要素のスタイルプロパティの値を取得します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• name: string

プロパティの名前。

戻り値​

string | undefined

インスタンス自体。

指定された名前のプロパティ値。

Param​

プロパティの名前。

Param​

新しい値。

参照​

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

参照​

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

定義元​

src/api/css.ts:27

css(this, prop, val)​

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

マッチしたすべての要素に対して、1つのCSSプロパティを設定します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• prop: string

プロパティの名前。

• val: string | (this, i, style) => undefined | string

新しい値。

戻り値​

Cheerio<T>

インスタンス自体。

インスタンス自体。

Param​

プロパティの名前。

Param​

新しい値。

参照​

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

参照​

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

定義元​

src/api/css.ts:40

css(this, map)​

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

一致するすべての要素に複数のCSSプロパティを設定します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• map: Record<string, string>

プロパティ名と値のマップ。

戻り値​

Cheerio<T>

インスタンス自体。

インスタンス自体。

Param​

プロパティの名前。

Param​

新しい値。

参照​

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

参照​

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

定義元​

src/api/css.ts:55

フォーム​

serialize()​

serialize<T>(this): string

フォーム要素のセットを、送信用の文字列としてエンコードします。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

戻り値​

string

シリアライズされたフォーム。

例​

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

参照​

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

定義元​

src/api/forms.ts:26

serializeArray()​

serializeArray<T>(this): object[]

フォーム要素のセットを、名前と値の配列としてエンコードします。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

戻り値​

object[]

シリアライズされたフォーム。

例​

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

参照​

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

定義元​

src/api/forms.ts:54

操作​

after()​

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

マッチした要素セット内の各要素の次にコンテンツを挿入します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• ...elems: BasicAcceptedElems<AnyNode>[] | [(this, i, html) => BasicAcceptedElems<AnyNode>]

HTML文字列、DOM要素、DOM要素の配列、またはマッチした要素セット内の各要素の後に挿入するCheerio。

戻り値​

Cheerio<T>

インスタンス自体。

例​

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

参照​

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

定義元​

src/api/manipulation.ts:637

append()​

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

選択された各要素の最後の子としてコンテンツを挿入します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• ...elems: BasicAcceptedElems<AnyNode>[] | [(this, i, html) => BasicAcceptedElems<AnyNode>]

戻り値​

Cheerio<T>

例​

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

参照​

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

定義元​

src/api/manipulation.ts:270

appendTo()​

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

マッチした要素セット内のすべての要素を、ターゲットの末尾に挿入します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• target: BasicAcceptedElems<AnyNode>

要素を追加するターゲット。

戻り値​

Cheerio<T>

インスタンス自体。

例​

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

参照​

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

定義元​

src/api/manipulation.ts:207

before()​

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

マッチした要素セット内の各要素の前にコンテンツを挿入します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• ...elems: BasicAcceptedElems<AnyNode>[] | [(this, i, html) => BasicAcceptedElems<AnyNode>]

マッチした要素のセット内の各要素の前に挿入するHTML文字列、DOM要素、DOM要素の配列、またはCheerio。

戻り値​

Cheerio<T>

インスタンス自体。

例​

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

参照​

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

定義元​

src/api/manipulation.ts:746

clone()​

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

Cheerioオブジェクトをクローンします。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

戻り値​

Cheerio<T>

クローンされたオブジェクト。

例​

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

参照​

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

定義元​

src/api/manipulation.ts:1099

empty()​

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

選択された各項目の子要素をすべて削除します。テキストノードとコメントノードはそのまま残されます。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

戻り値​

Cheerio<T>

インスタンス自体。

例​

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

参照​

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

定義元​

src/api/manipulation.ts:935

html()​

html(this)​

html<T>(this): string | null

最初に選択された要素からHTMLコンテンツ文字列を取得します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

戻り値​

string | null

HTMLコンテンツ文字列。

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

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

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

定義元​

src/api/manipulation.ts:963

html(this, str)​

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

選択された各要素のコンテンツを指定されたコンテンツに置き換えます。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• str: string | Cheerio<T>

選択されたコンテンツを置き換えるコンテンツ。

戻り値​

Cheerio<T>

インスタンス自体。

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

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

定義元​

src/api/manipulation.ts:979

insertAfter()​

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

マッチした要素のセット内のすべての要素をターゲットの後ろに挿入します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• target: BasicAcceptedElems<AnyNode>

要素を挿入する対象の要素。

戻り値​

Cheerio<T>

新しく挿入された要素のセット。

例​

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

参照​

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

定義元​

src/api/manipulation.ts:690

insertBefore()​

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

マッチした要素のセット内のすべての要素をターゲットの前に挿入します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• target: BasicAcceptedElems<AnyNode>

要素を挿入する対象の要素。

戻り値​

Cheerio<T>

新しく挿入された要素のセット。

例​

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

参照​

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

定義元​

src/api/manipulation.ts:799

prepend()​

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

選択された各要素の最初の子としてコンテンツを挿入します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• ...elems: BasicAcceptedElems<AnyNode>[] | [(this, i, html) => BasicAcceptedElems<AnyNode>]

戻り値​

Cheerio<T>

例​

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

参照​

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

定義元​

src/api/manipulation.ts:298

prependTo()​

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

マッチした要素のセット内のすべての要素をターゲットの先頭に挿入します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• target: BasicAcceptedElems<AnyNode>

要素を先頭に追加する対象の要素。

戻り値​

Cheerio<T>

インスタンス自体。

例​

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

参照​

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

定義元​

src/api/manipulation.ts:240

remove()​

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

DOMからマッチした要素のセットとそのすべての子を削除します。selectorは、削除するマッチした要素のセットをフィルタリングします。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• selector?: string

削除する要素のオプションのセレクター。

戻り値​

Cheerio<T>

インスタンス自体。

例​

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

参照​

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

定義元​

src/api/manipulation.ts:851

replaceWith()​

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

マッチした要素をcontentに置き換えます。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• content: AcceptedElems<AnyNode>

マッチした要素の置換。

戻り値​

Cheerio<T>

インスタンス自体。

例​

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>

参照​

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

定義元​

src/api/manipulation.ts:887

text()​

text(this)​

text<T>(this): string

マッチした要素のセット内の各要素（およびその子孫要素）の結合されたテキストコンテンツを取得します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

戻り値​

string

コレクションのテキストコンテンツ。

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

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

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

定義元​

src/api/manipulation.ts:1037

text(this, str)​

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

マッチした要素のセット内の各要素のコンテンツを、指定されたテキストに設定します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• str: string | (this, i, text) => string

各マッチした要素のコンテンツとして設定するテキスト。

戻り値​

Cheerio<T>

インスタンス自体。

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

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

定義元​

src/api/manipulation.ts:1054

toString()​

toString<T>(this): string

コレクションを文字列に変換します。.html() のエイリアスです。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

戻り値​

string

レンダリングされたドキュメント。

定義元​

src/api/manipulation.ts:1013

unwrap()​

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

.unwrap()関数は、マッチした要素のセットの親をDOMから削除し、マッチした要素をその場所に残します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• selector?: string

親要素をチェックするためのセレクター。要素の親がセレクターに一致しない場合、その要素はアンラップされません。

戻り値​

Cheerio<T>

チェインのためのインスタンス自体。

例​

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>

参照​

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

定義元​

src/api/manipulation.ts:514

wrap()​

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

.wrap()関数は、DOM構造を指定するために$()ファクトリ関数に渡すことができる任意の文字列またはオブジェクトを受け取ることができます。この構造は、数レベルの深さまでネストすることができますが、最も内側の要素は1つだけを含む必要があります。この構造のコピーが、マッチした要素のセット内の各要素の周囲にラップされます。このメソッドは、チェーン処理のために元の要素のセットを返します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• wrapper: AcceptedElems<AnyNode>

選択内の各要素をラップするDOM構造。

戻り値​

Cheerio<T>

例​

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>

参照​

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

定義元​

src/api/manipulation.ts:403

wrapAll()​

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

.wrapAll()関数は、$()関数に渡してDOM構造を指定できる任意の文字列またはオブジェクトを受け取ることができます。この構造は、数レベルの深さまでネストできますが、最も内側の要素は1つだけを含む必要があります。構造は、マッチした要素のセット内のすべての要素を、単一のグループとしてまとめてラップします。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• wrapper: AcceptedElems<T>

選択内のすべてのマッチした要素をラップするDOM構造。

戻り値​

Cheerio<T>

インスタンス自体。

例​

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>

参照​

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

定義元​

src/api/manipulation.ts:577

wrapInner()​

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

.wrapInner()関数は、DOM構造を指定するために$()ファクトリ関数に渡すことができる任意の文字列またはオブジェクトを受け取ることができます。この構造は、数レベルの深さまでネストすることができますが、最も内側の要素は1つだけを含む必要があります。構造は、マッチした要素のセット内の各要素のコンテンツの周囲にラップされます。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• wrapper: AcceptedElems<AnyNode>

選択内の各要素のコンテンツをラップするDOM構造。

戻り値​

Cheerio<T>

チェインのためのインスタンス自体。

例​

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>

参照​

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

定義元​

src/api/manipulation.ts:466

その他​

cheerio​

cheerio: "[cheerio オブジェクト]"

定義元​

src/cheerio.ts:118

length​

length: number = 0

実装​

ArrayLike.length

定義元​

src/cheerio.ts:40

options​

options: InternalOptions

定義元​

src/cheerio.ts:43

prevObject​

prevObject: undefined | Cheerio<any>

定義元​

src/cheerio.ts:77

splice()​

splice: (start, deleteCount?) => any[](start, deleteCount, ...items) => any[]

配列から要素を削除し、必要に応じて新しい要素を挿入して、削除された要素を返します。

パラメータ​

• start: number

要素の削除を開始する配列内のゼロベースの位置。

• deleteCount?: number

削除する要素の数。

戻り値​

any[]

削除された要素を含む配列。

配列から要素を削除し、必要に応じて新しい要素を挿入して、削除された要素を返します。

パラメータ​

• start: number

要素の削除を開始する配列内のゼロベースの位置。

• deleteCount: number

削除する要素の数。

• ...items: any[]

削除された要素の代わりに配列に挿入する要素。

戻り値​

any[]

削除された要素を含む配列。

定義場所​

src/cheerio.ts:120

[iterator]()​

[iterator](): Iterator<T, any, undefined>

戻り値​

Iterator<T, any, undefined>

定義場所​

website/node_modules/typescript/lib/lib.es2015.iterable.d.ts:49

extract()​

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

ドキュメントから複数の値を抽出し、オブジェクトに格納します。

型パラメータ​

• M extends ExtractMap

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• map: M

キーと値のペアを含むオブジェクト。キーはオブジェクトに作成されるプロパティの名前で、値は値を抽出するために使用されるセレクターです。

戻り値​

ExtractedMap<M>

抽出された値を含むオブジェクト。

定義場所​

src/api/extract.ts:62

filterArray()​

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

型パラメータ​

• T

パラメータ​

• nodes: T[]

• match: AcceptedFilters<T>

• xmlMode?: boolean

• root?: Document

戻り値​

Element[] | T[]

定義場所​

src/api/traversing.ts:787

foo()​

foo(): void

戻り値​

void

定義場所​

src/cheerio.spec.ts:13

myPlugin()​

myPlugin(...args): object

パラメータ​

• ...args: unknown[]

戻り値​

object

args​

args: unknown[]

context​

context: Cheerio<T>

定義場所​

src/cheerio.spec.ts:9

toArray()​

toArray<T>(this): T[]

jQueryセットに含まれるすべてのDOM要素を配列として取得します。

型パラメータ​

• T

パラメータ​

• this: Cheerio<T>

戻り値​

T[]

含まれているアイテム。

例​

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

定義場所​

src/api/traversing.ts:1027

トラバーシング​

add()​

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

一致する要素のセットに要素を追加します。

型パラメータ​

• S extends AnyNode

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• other: string | S | Cheerio<S> | S[]

追加する要素。

• context?: string | Cheerio<S>

オプションで、新しい選択のコンテキスト。

戻り値​

Cheerio<S | T>

結合されたセット。

例​

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

参照​

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

定義場所​

src/api/traversing.ts:1138

addBack()​

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

必要に応じてセレクターでフィルタリングして、スタック上の前の要素のセットを現在のセットに追加します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• selector?: string

追加する要素のセレクター。

戻り値​

Cheerio<AnyNode>

結合されたセット。

例​

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

参照​

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

定義場所​

src/api/traversing.ts:1164

children()​

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

一致する要素のセット内の各要素の子要素を取得します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• selector?: AcceptedFilters<Element>

指定された場合は子をフィルタリングします。

戻り値​

Cheerio<Element>

子要素。

例​

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

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

参照​

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

定義場所​

src/api/traversing.ts:581

closest()​

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

セット内の各要素について、要素自体をテストし、DOMツリー内でその祖先をたどることにより、セレクターに一致する最初の要素を取得します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• selector?: AcceptedFilters<Element>

検索する要素のセレクター。

戻り値​

Cheerio<AnyNode>

最も近いノード。

例​

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

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

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

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

参照​

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

定義場所​

src/api/traversing.ts:341

contents()​

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

マッチした要素のセット内の各要素の子要素を取得します。テキストノードとコメントノードを含みます。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

戻り値​

Cheerio<AnyNode>

子要素。

例​

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

参照​

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

定義元​

src/api/traversing.ts:604

each()​

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

Cheerioオブジェクトを反復処理し、マッチした各要素に対して関数を実行します。コールバックが起動されると、関数はDOM要素のコンテキストで起動されるため、thisは現在の要素を参照し、これは関数パラメータelementと同等です。eachループから早期に抜け出すには、falseを返します。

型パラメータ​

• T

パラメータ​

• this: Cheerio<T>

• fn

実行する関数。

戻り値​

Cheerio<T>

インスタンス自体。チェーン処理に便利です。

例​

const fruits = [];

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

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

参照​

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

定義元​

src/api/traversing.ts:640

end()​

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

現在のチェーンで最新のフィルタリング操作を終了し、マッチした要素のセットを前の状態に戻します。

型パラメータ​

• T

パラメータ​

• this: Cheerio<T>

戻り値​

Cheerio<AnyNode>

マッチした要素のセットの前の状態。

例​

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

参照​

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

定義元​

src/api/traversing.ts:1118

eq()​

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

マッチした要素のセットを指定されたインデックスの1つに絞り込みます。最後に選択された要素から逆方向に数えるには、.eq(-i)を使用します。

型パラメータ​

• T

パラメータ​

• this: Cheerio<T>

• i: number

選択する要素のインデックス。

戻り値​

Cheerio<T>

i番目の位置にある要素。

例​

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

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

参照​

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

定義元​

src/api/traversing.ts:966

filter()​

filter(this, match)​

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

Cheerioオブジェクトを反復処理し、セレクターに一致するか、関数のテストに合格した要素に、セレクター要素のセットを絞り込みます。

これは型ガードを使用するための定義です。このメソッドを呼び出す他の方法については、以下を参照してください。関数は選択された要素のコンテキストで実行されるため、thisは現在の要素を参照します。

型パラメータ​

• T

• S

パラメータ​

• this: Cheerio<T>

• match

上記ルールに従って検索する値。

戻り値​

Cheerio<S>

フィルタリングされたコレクション。

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

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

定義元​

src/api/traversing.ts:735

filter(this, match)​

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

Cheerioオブジェクトを反復処理し、セレクターに一致するか、関数のテストに合格した要素に、セレクター要素のセットを絞り込みます。

  • Cheerioの選択が指定されている場合、その選択に含まれる要素のみを返します。
  • 要素が指定されている場合、その要素のみを返します（元の選択に含まれている場合）。
  • 関数メソッドを使用する場合、関数は選択された要素のコンテキストで実行されるため、thisは現在の要素を参照します。
型パラメータ​

• T

• S

パラメータ​

• this: Cheerio<T>

• match: S

上記ルールに従って検索する値。AcceptedFiltersを参照してください。

戻り値​

Cheerio<S extends string ? Element : T>

フィルタリングされたコレクション。

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

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

定義元​

src/api/traversing.ts:774

find()​

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

現在のマッチした要素のセット内の各要素の子孫を、セレクター、jQueryオブジェクト、または要素でフィルタリングして取得します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• selectorOrHaystack?: string | Element | Cheerio<Element>

検索する要素。

戻り値​

Cheerio<Element>

見つかった要素。

例​

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

参照​

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

定義元​

src/api/traversing.ts:47

first()​

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

Cheerioオブジェクトの最初の要素を選択します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

戻り値​

Cheerio<T>

最初の要素。

例​

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

参照​

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

定義元​

src/api/traversing.ts:925

get()​

get(this, i)​

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

Cheerioオブジェクトによってマッチされた要素の1つを、i番目の位置で取得します。

型パラメータ​

• T

パラメータ​

• this: Cheerio<T>

• i: number

取得する要素。

戻り値​

T | undefined

i番目の位置にある要素。

例​
$('li').get(0).tagName;
//=> li
参照​

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

定義場所​

src/api/traversing.ts:992

get(this)​

get<T>(this): T[]

Cheerioオブジェクトによってマッチしたすべての要素を配列として取得します。

型パラメータ​

• T

パラメータ​

• this: Cheerio<T>

戻り値​

T[]

Cheerioオブジェクトによってマッチしたすべての要素。

例​
$('li').get().length;
//=> 3
参照​

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

定義場所​

src/api/traversing.ts:1007

has()​

has(this, selectorOrHaystack): Cheerio<AnyNode | Element>

マッチした要素のセットを、指定されたDOM要素を子孫として持つか、指定されたセレクターに一致する子孫を持つものだけにフィルタリングします。.filter(':has(selector)')と同等です。

パラメータ​

• this: Cheerio<AnyNode>

• selectorOrHaystack: string | Element | Cheerio<Element>

検索する要素。

戻り値​

Cheerio<AnyNode | Element>

フィルタリングされたコレクション。

例​

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

参照​

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

定義場所​

src/api/traversing.ts:899

index()​

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

マッチした要素の中から、指定された要素を検索します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• selectorOrNeedle?: string | AnyNode | Cheerio<AnyNode>

検索する要素。

戻り値​

number

要素のインデックス。

例​

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

参照​

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

定義場所​

src/api/traversing.ts:1049

is()​

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

現在の要素リストを確認し、要素のいずれかがセレクターに一致する場合にtrueを返します。要素またはCheerioの選択を使用する場合、要素のいずれかが一致する場合にtrueを返します。述語関数を使用する場合、関数は選択された要素のコンテキストで実行されるため、thisは現在の要素を参照します。

型パラメータ​

• T

パラメータ​

• this: Cheerio<T>

• selector?: AcceptedFilters<T>

選択のセレクター。

戻り値​

boolean

セレクターがインスタンスの要素に一致するかどうか。

参照​

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

定義場所​

src/api/traversing.ts:810

last()​

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

cheerioオブジェクトの最後の要素を選択します。

型パラメータ​

• T

パラメータ​

• this: Cheerio<T>

戻り値​

Cheerio<T>

最後の要素。

例​

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

参照​

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

定義場所​

src/api/traversing.ts:943

map()​

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

現在マッチしているセット内の各要素を関数に通し、戻り値を含む新しいCheerioオブジェクトを生成します。関数は、個々のデータ項目または結果のセットに挿入されるデータ項目の配列を返すことができます。配列が返された場合、配列内の要素がセットに挿入されます。関数がnullまたはundefinedを返す場合、要素は挿入されません。

型パラメータ​

• T

• M

パラメータ​

• this: Cheerio<T>

• fn

実行する関数。

戻り値​

Cheerio<M>

マップされた要素。Cheerioコレクションでラップされています。

例​

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

参照​

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

定義場所​

src/api/traversing.ts:676

next()​

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

選択された各要素の次の兄弟要素を取得します。オプションで、セレクターでフィルタリングできます。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• selector?: AcceptedFilters<Element>

指定した場合、兄弟要素をフィルタリングします。

戻り値​

Cheerio<Element>

次のノード。

例​

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

参照​

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

定義場所​

src/api/traversing.ts:396

nextAll()​

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

選択された各要素の次のすべての兄弟要素を取得します。オプションで、セレクターでフィルタリングできます。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• selector?: AcceptedFilters<Element>

指定した場合、兄弟要素をフィルタリングします。

戻り値​

Cheerio<Element>

次のノード。

例​

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

参照​

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

定義場所​

src/api/traversing.ts:419

nextUntil()​

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

セレクターによってマッチした要素まで（ただし、その要素は含まず）の次のすべての兄弟要素を取得します。オプションで別のセレクターでフィルタリングできます。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• selector?: null | AcceptedFilters<Element>

停止する要素のセレクター。

• filterSelector?: AcceptedFilters<Element>

指定した場合、兄弟要素をフィルタリングします。

戻り値​

Cheerio<Element>

次のノード。

例​

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

参照​

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

定義場所​

src/api/traversing.ts:448

not()​

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

マッチした要素のセットから要素を削除します。DOM要素のセットを表すCheerioオブジェクトが与えられたとき、.not()メソッドは、マッチした要素のサブセットから新しいCheerioオブジェクトを構築します。指定されたセレクタが各要素に対してテストされ、セレクタにマッチしない要素が結果に含まれます。

.not()メソッドは、.filter()と同じように、引数に関数を取ることができます。関数がtrueを返す要素は、フィルタリングされたセットから除外されます。それ以外のすべての要素が含まれます。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• match: AcceptedFilters<T>

上記ルールに従って検索する値。

戻り値​

Cheerio<T>

フィルタリングされたコレクション。

例​

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

参照​

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

定義元​

src/api/traversing.ts:858

parent()​

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

マッチした要素の現在のセット内の各要素の親を取得します。オプションで、セレクタでフィルタリングできます。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• selector?: AcceptedFilters<Element>

指定された場合、親をフィルタリングします。

戻り値​

Cheerio<Element>

親要素。

例​

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

参照​

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

定義元​

src/api/traversing.ts:245

parents()​

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

マッチした要素の現在のセット内の各要素について、selectorでフィルタリングされた親のセットを取得します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• selector?: AcceptedFilters<Element>

指定された場合、親をフィルタリングします。

戻り値​

Cheerio<Element>

親要素。

例​

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

参照​

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

定義元​

src/api/traversing.ts:271

parentsUntil()​

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

マッチした要素の現在のセット内の各要素の祖先を、セレクタ、DOMノード、またはcheerioオブジェクトによってマッチした要素の手前まで（それを含まず）取得します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• selector?: null | AcceptedFilters<Element>

停止する要素のセレクター。

• filterSelector?: AcceptedFilters<Element>

親要素をフィルタリングするためのオプション。

戻り値​

Cheerio<Element>

親要素。

例​

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

参照​

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

定義元​

src/api/traversing.ts:305

prev()​

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

選択された各要素の前の兄弟要素を、オプションでセレクタでフィルタリングして取得します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• selector?: AcceptedFilters<Element>

指定した場合、兄弟要素をフィルタリングします。

戻り値​

Cheerio<Element>

前のノード。

例​

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

参照​

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

定義元​

src/api/traversing.ts:473

prevAll()​

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

選択された各要素の前のすべての兄弟要素を、オプションでセレクタでフィルタリングして取得します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• selector?: AcceptedFilters<Element>

指定した場合、兄弟要素をフィルタリングします。

戻り値​

Cheerio<Element>

前のノード。

例​

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

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

参照​

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

定義元​

src/api/traversing.ts:497

prevUntil()​

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

セレクタによってマッチした要素の手前まで（それを含まず）のすべての前の兄弟要素を、オプションで別のセレクタでフィルタリングして取得します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• selector?: null | AcceptedFilters<Element>

停止する要素のセレクター。

• filterSelector?: AcceptedFilters<Element>

指定した場合、兄弟要素をフィルタリングします。

戻り値​

Cheerio<Element>

前のノード。

例​

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

参照​

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

定義元​

src/api/traversing.ts:526

siblings()​

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

マッチした要素のセット内の各要素の兄弟要素（その要素自体を除く）を、オプションでセレクタでフィルタリングして取得します。

型パラメータ​

• T extends AnyNode

パラメータ​

• this: Cheerio<T>

• selector?: AcceptedFilters<Element>

指定した場合、兄弟要素をフィルタリングします。

戻り値​

Cheerio<Element>

兄弟要素。

例​

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

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

参照​

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

定義元​

src/api/traversing.ts:554

slice()​

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

指定された範囲（0ベースの位置）に一致する要素を取得します。

型パラメータ​

• T

パラメータ​

• this: Cheerio<T>

• start?: number

要素の選択を開始する位置。負の場合は、セットの末尾からのオフセットを示します。

• end?: number

要素の選択を停止する位置。負の場合は、セットの末尾からのオフセットを示します。省略した場合、範囲はセットの末尾まで続きます。

戻り値​

Cheerio<T>

指定された範囲に一致する要素。

例​

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

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

参照​

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

定義元​

src/api/traversing.ts:1095