73 lines
2.8 KiB
TypeScript
73 lines
2.8 KiB
TypeScript
|
/// <reference types="node" />
|
||
|
|
import { CheerioOptions, InternalOptions } from './options';
|
||
|
|
import * as staticMethods from './static';
|
||
|
|
import { Cheerio } from './cheerio';
|
||
|
|
import type { Node, Document, Element } from 'domhandler';
|
||
|
|
import type * as Load from './load';
|
||
|
|
import { SelectorType, BasicAcceptedElems } from './types';
|
||
|
|
declare type StaticType = typeof staticMethods;
|
||
|
|
declare type LoadType = typeof Load;
|
||
|
|
/**
|
||
|
|
* A querying function, bound to a document created from the provided markup.
|
||
|
|
*
|
||
|
|
* Also provides several helper methods for dealing with the document as a whole.
|
||
|
|
*/
|
||
|
|
export interface CheerioAPI extends StaticType, LoadType {
|
||
|
|
/**
|
||
|
|
* This selector method is the starting point for traversing and manipulating
|
||
|
|
* the document. Like jQuery, it's the primary method for selecting elements
|
||
|
|
* in the document.
|
||
|
|
*
|
||
|
|
* `selector` searches within the `context` scope which searches within the
|
||
|
|
* `root` scope.
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
*
|
||
|
|
* ```js
|
||
|
|
* $('.apple', '#fruits').text();
|
||
|
|
* //=> Apple
|
||
|
|
*
|
||
|
|
* $('ul .pear').attr('class');
|
||
|
|
* //=> pear
|
||
|
|
*
|
||
|
|
* $('li[class=orange]').html();
|
||
|
|
* //=> Orange
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* @param selector - Either a selector to look for within the document, or the
|
||
|
|
* contents of a new Cheerio instance.
|
||
|
|
* @param context - Either a selector to look for within the root, or the
|
||
|
|
* contents of the document to query.
|
||
|
|
* @param root - Optional HTML document string.
|
||
|
|
*/
|
||
|
|
<T extends Node, S extends string>(selector?: S | BasicAcceptedElems<T>, context?: BasicAcceptedElems<Node> | null, root?: BasicAcceptedElems<Document>, options?: CheerioOptions): Cheerio<S extends SelectorType ? Element : T>;
|
||
|
|
/**
|
||
|
|
* The root the document was originally loaded with.
|
||
|
|
*
|
||
|
|
* @private
|
||
|
|
*/
|
||
|
|
_root: Document;
|
||
|
|
/**
|
||
|
|
* The options the document was originally loaded with.
|
||
|
|
*
|
||
|
|
* @private
|
||
|
|
*/
|
||
|
|
_options: InternalOptions;
|
||
|
|
/** Mimic jQuery's prototype alias for plugin authors. */
|
||
|
|
fn: typeof Cheerio.prototype;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Create a querying function, bound to a document created from the provided
|
||
|
|
* markup. Note that similar to web browser contexts, this operation may
|
||
|
|
* introduce `<html>`, `<head>`, and `<body>` elements; set `isDocument` to
|
||
|
|
* `false` to switch to fragment mode and disable this.
|
||
|
|
*
|
||
|
|
* @param content - Markup to be loaded.
|
||
|
|
* @param options - Options for the created instance.
|
||
|
|
* @param isDocument - Allows parser to be switched to fragment mode.
|
||
|
|
* @returns The loaded document.
|
||
|
|
* @see {@link https://cheerio.js.org#loading} for additional usage information.
|
||
|
|
*/
|
||
|
|
export declare function load(content: string | Node | Node[] | Buffer, options?: CheerioOptions | null, isDocument?: boolean): CheerioAPI;
|
||
|
|
export {};
|
||
|
|
//# sourceMappingURL=load.d.ts.map
|