UNPKG

2.24 kBTypeScriptView Raw
1/**
2 * The main types of Cheerio objects.
3 *
4 * @category Cheerio
5 */
6export type { Cheerio } from './cheerio';
7/**
8 * Types used in signatures of Cheerio methods.
9 *
10 * @category Cheerio
11 */
12export * from './types';
13export type { CheerioOptions, HTMLParser2Options, Parse5Options, } from './options';
14/**
15 * Re-exporting all of the node types.
16 *
17 * @category DOM Node
18 */
19export type { Node, NodeWithChildren, Element, Document } from 'domhandler';
20export * from './load';
21declare const _default: import("./load").CheerioAPI;
22/**
23 * The default cheerio instance.
24 *
25 * @deprecated Use the function returned by `load` instead.
26 */
27export default _default;
28import * as staticMethods from './static';
29/**
30 * In order to promote consistency with the jQuery library, users are encouraged
31 * to instead use the static method of the same name.
32 *
33 * @deprecated
34 * @example
35 *
36 * ```js
37 * const $ = cheerio.load('<div><p></p></div>');
38 *
39 * $.contains($('div').get(0), $('p').get(0));
40 * //=> true
41 *
42 * $.contains($('p').get(0), $('div').get(0));
43 * //=> false
44 * ```
45 *
46 * @returns {boolean}
47 */
48export declare const contains: typeof staticMethods.contains;
49/**
50 * In order to promote consistency with the jQuery library, users are encouraged
51 * to instead use the static method of the same name.
52 *
53 * @deprecated
54 * @example
55 *
56 * ```js
57 * const $ = cheerio.load('');
58 *
59 * $.merge([1, 2], [3, 4]);
60 * //=> [1, 2, 3, 4]
61 * ```
62 */
63export declare const merge: typeof staticMethods.merge;
64/**
65 * In order to promote consistency with the jQuery library, users are encouraged
66 * to instead use the static method of the same name as it is defined on the
67 * "loaded" Cheerio factory function.
68 *
69 * @deprecated See {@link static/parseHTML}.
70 * @example
71 *
72 * ```js
73 * const $ = cheerio.load('');
74 * $.parseHTML('<b>markup</b>');
75 * ```
76 */
77export declare const parseHTML: typeof staticMethods.parseHTML;
78/**
79 * Users seeking to access the top-level element of a parsed document should
80 * instead use the `root` static method of a "loaded" Cheerio function.
81 *
82 * @deprecated
83 * @example
84 *
85 * ```js
86 * const $ = cheerio.load('');
87 * $.root();
88 * ```
89 */
90export declare const root: typeof staticMethods.root;
91//# sourceMappingURL=index.d.ts.map
\No newline at end of file