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

インターフェース: CheerioAPI()

提供されたマークアップから作成されたドキュメントにバインドされたクエリ関数。

ドキュメント全体を扱うためのいくつかのヘルパーメソッドも提供します。

拡張​

  • StaticType

CheerioAPI<T, S>(selector?, context?, root?, options?): Cheerio<S extends SelectorType ? Element : T>

提供されたマークアップから作成されたドキュメントにバインドされたクエリ関数。

ドキュメント全体を扱うためのいくつかのヘルパーメソッドも提供します。

型パラメータ​

• T extends AnyNode

• S extends string

パラメータ​

• selector?: S | BasicAcceptedElems<T>

ドキュメント内で検索するセレクタ、または新しいCheerioインスタンスのコンテンツのいずれか。

• context?: null | BasicAcceptedElems<AnyNode>

ルート内で検索するセレクタ、またはクエリするドキュメントのコンテンツのいずれか。

• root?: BasicAcceptedElems<Document>

オプションのHTMLドキュメント文字列。

• options?: CheerioOptions

戻り値​

Cheerio<S extends SelectorType ? Element : T>

例​

$('ul .pear').attr('class');
//=> pear

$('li[class=orange]').html();
//=> Orange

$('.apple', '#fruits').text();
//=> Apple

オプションで、文字列をセレクタとして渡すことでHTMLをロードすることもできます

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

またはコンテキスト

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

またはルートとして

$('li', 'ul', '<ul id="fruits">...</ul>');

定義元​

src/load.ts:66

非推奨​

load()​

load: (content, options?, isDocument) => CheerioAPI

「ロードされた」Cheerioファクトリ関数で定義された.load静的メソッドは非推奨です。代わりに、Cheerioモジュールからエクスポートされたload関数を使用することをお勧めします。

パラメータ​

• content: string | AnyNode | AnyNode[] | Buffer

• options?: null | CheerioOptions

• isDocument?: boolean = true

戻り値​

CheerioAPI

非推奨​

Cheerioモジュールからエクスポートされたload関数を使用してください。

例​

const $ = cheerio.load('<h1>Hello, <span>world</span>.</h1>');

定義元​

src/load.ts:103

その他​

contains​

containsを再エクスポート

merge​

mergeを再エクスポート

fn​

fn: Cheerio<any>

プラグイン作成者向けのjQueryのプロトタイプエイリアスを模倣します。

定義元​

src/load.ts:88

静的​

extract()​

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

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

型パラメータ​

• M extends ExtractMap

パラメータ​

• this: CheerioAPI

• map: M

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

戻り値​

ExtractedMap<M>

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

継承元​

StaticType.extract

定義元​

src/static.ts:248

html()​

html(this, options)​

html(this, options?): string

ドキュメントをレンダリングします。

パラメータ​

• this: CheerioAPI

• options?: CheerioOptions

レンダラーのオプション。

戻り値​

string

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

継承元​

StaticType.html

定義元​

src/static.ts:58

html(this, dom, options)​

html(this, dom?, options?): string

ドキュメントをレンダリングします。

パラメータ​

• this: CheerioAPI

• dom?: BasicAcceptedElems<AnyNode>

レンダリングする要素。

• options?: CheerioOptions

レンダラーのオプション。

戻り値​

string

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

継承元​

StaticType.html

定義元​

src/static.ts:67

parseHTML()​

parseHTML(this, data, context, keepScripts)​

parseHTML(this, data, context?, keepScripts?): AnyNode[]

文字列をDOMノードの配列に解析します。context引数はCheerioでは意味を持ちませんが、jQueryとのAPI互換性を維持するために保持されます。

パラメータ​

• this: CheerioAPI

• data: string

パースされるマークアップ。

• context?: unknown

無視されます。ブール値の場合、keepScriptsの値として使用されます。

• keepScripts?: boolean

falseの場合、すべてのスクリプトが削除されます。

戻り値​

AnyNode[]

パースされたDOM。

エイリアス​

Cheerio.parseHTML

参照​

https://api.jquery.com/jQuery.parseHTML/

継承元​

StaticType.parseHTML

定義元​

src/static.ts:152

parseHTML(this, data)​

parseHTML(this, data?): null

パラメータ​

• this: CheerioAPI

• data?: null | ""

戻り値​

null

継承元​

StaticType.parseHTML

定義元​

src/static.ts:158

root()​

root(this): Cheerio<Document>

トップレベルのルート要素を操作する必要がある場合があります。それをクエリするには、$.root()を使用できます。

パラメータ​

• this: CheerioAPI

戻り値​

Cheerio<Document>

ルートノードをラップするCheerioインスタンス。

例​

$.root().append('<ul id="vegetables"></ul>').html();
//=> <ul id="fruits">...</ul><ul id="vegetables"></ul>

エイリアス​

Cheerio.root

継承元​

StaticType.root

定義元​

src/static.ts:203

text()​

text(this, elements?): string

ドキュメントをテキストとしてレンダリングします。

これは、渡された要素のtextContentを返します。結果には、<script>および<style>要素の内容が含まれます。これを避けるには、代わりに.prop('innerText')を使用してください。

パラメータ​

• this: void | CheerioAPI

• elements?: ArrayLike<AnyNode>

レンダリングする要素。

戻り値​

string

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

継承元​

StaticType.text

定義元​

src/static.ts:124

xml()​

xml(this, dom?): string

ドキュメントをXMLとしてレンダリングします。

パラメータ​

• this: CheerioAPI

• dom?: BasicAcceptedElems<AnyNode>

レンダリングする要素。

戻り値​

string

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

継承元​

StaticType.xml

定義元​

src/static.ts:104