dockjss

Paused

App Files Files Community

dockjss / web-content /node_modules /cheerio /src /load.ts

franyer24

Upload 1895 files

2e178e3 verified about 1 year ago

Raw

History Blame Contribute Delete

8.21 kB

	import {
	type CheerioOptions,
	type InternalOptions,
	flattenOptions,
	} from './options.js';
	import * as staticMethods from './static.js';
	import { Cheerio } from './cheerio.js';
	import { isHtml, isCheerio } from './utils.js';
	import type { AnyNode, Document, Element, ParentNode } from 'domhandler';
	import type { SelectorType, BasicAcceptedElems } from './types.js';

	type StaticType = typeof staticMethods;

	/**
	* 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 {
	/**
	* 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
	* $('ul .pear').attr('class');
	* //=> pear
	*
	* $('li[class=orange]').html();
	* //=> Orange
	*
	* $('.apple', '#fruits').text();
	* //=> Apple
	* ```
	*
	* Optionally, you can also load HTML by passing the string as the selector:
	*
	* ```js
	* $('<ul id="fruits">...</ul>');
	* ```
	*
	* Or the context:
	*
	* ```js
	* $('ul', '<ul id="fruits">...</ul>');
	* ```
	*
	* Or as the root:
	*
	* ```js
	* $('li', 'ul', '<ul id="fruits">...</ul>');
	* ```
	*
	* @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 AnyNode, S extends string>(
	selector?: S \| BasicAcceptedElems<T>,
	context?: BasicAcceptedElems<AnyNode> \| 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;

	/**
	* The `.load` static method defined on the "loaded" Cheerio factory function
	* is deprecated. Users are encouraged to instead use the `load` function
	* exported by the Cheerio module.
	*
	* @deprecated Use the `load` function exported by the Cheerio module.
	* @category Deprecated
	* @example
	*
	* ```js
	* const $ = cheerio.load('<h1>Hello, <span>world</span>.</h1>');
	* ```
	*/
	load: ReturnType<typeof getLoad>;
	}

	export function getLoad(
	parse: typeof Cheerio.prototype._parse,
	render: (
	dom: AnyNode \| ArrayLike<AnyNode>,
	options: InternalOptions,
	) => string,
	) {
	/**
	* 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.
	*/
	return function load(
	content: string \| AnyNode \| AnyNode[] \| Buffer,
	options?: CheerioOptions \| null,
	isDocument = true,
	): CheerioAPI {
	if ((content as string \| null) == null) {
	throw new Error('cheerio.load() expects a string');
	}

	const internalOpts = flattenOptions(options);
	const initialRoot = parse(content, internalOpts, isDocument, null);

	/**
	* Create an extended class here, so that extensions only live on one
	* instance.
	*/
	class LoadedCheerio<T> extends Cheerio<T> {
	_make<T>(
	selector?: ArrayLike<T> \| T \| string,
	context?: BasicAcceptedElems<AnyNode> \| null,
	): Cheerio<T> {
	const cheerio = initialize(selector, context);
	cheerio.prevObject = this;

	return cheerio;
	}

	_parse(
	content: string \| Document \| AnyNode \| AnyNode[] \| Buffer,
	options: InternalOptions,
	isDocument: boolean,
	context: ParentNode \| null,
	) {
	return parse(content, options, isDocument, context);
	}

	_render(dom: AnyNode \| ArrayLike<AnyNode>): string {
	return render(dom, this.options);
	}
	}

	function initialize<T = AnyNode, S extends string = string>(
	selector?: ArrayLike<T> \| T \| S,
	context?: BasicAcceptedElems<AnyNode> \| null,
	root: BasicAcceptedElems<Document> = initialRoot,
	opts?: CheerioOptions,
	): Cheerio<S extends SelectorType ? Element : T> {
	type Result = S extends SelectorType ? Element : T;

	// $($)
	if (selector && isCheerio<Result>(selector)) return selector;

	const options = flattenOptions(opts, internalOpts);
	const r =
	typeof root === 'string'
	? [parse(root, options, false, null)]
	: 'length' in root
	? root
	: [root];
	const rootInstance = isCheerio<Document>(r)
	? r
	: new LoadedCheerio<Document>(r, null, options);
	// Add a cyclic reference, so that calling methods on `_root` never fails.
	rootInstance._root = rootInstance;

	// $(), $(null), $(undefined), $(false)
	if (!selector) {
	return new LoadedCheerio<Result>(undefined, rootInstance, options);
	}

	const elements: AnyNode[] \| undefined =
	typeof selector === 'string' && isHtml(selector)
	? // $(<html>)
	parse(selector, options, false, null).children
	: isNode(selector)
	? // $(dom)
	[selector]
	: Array.isArray(selector)
	? // $([dom])
	selector
	: undefined;

	const instance = new LoadedCheerio(elements, rootInstance, options);

	if (elements) {
	return instance as any;
	}

	if (typeof selector !== 'string') {
	throw new TypeError('Unexpected type of selector');
	}

	// We know that our selector is a string now.
	let search = selector;

	const searchContext: Cheerio<AnyNode> \| undefined = context
	? // If we don't have a context, maybe we have a root, from loading
	typeof context === 'string'
	? isHtml(context)
	? // $('li', '<ul>...</ul>')
	new LoadedCheerio<Document>(
	[parse(context, options, false, null)],
	rootInstance,
	options,
	)
	: // $('li', 'ul')
	((search = `${context} ${search}` as S), rootInstance)
	: isCheerio<AnyNode>(context)
	? // $('li', $)
	context
	: // $('li', node), $('li', [nodes])
	new LoadedCheerio<AnyNode>(
	Array.isArray(context) ? context : [context],
	rootInstance,
	options,
	)
	: rootInstance;

	// If we still don't have a context, return
	if (!searchContext) return instance as any;

	/*
	* #id, .class, tag
	*/
	return searchContext.find(search) as Cheerio<Result>;
	}

	// Add in static methods & properties
	Object.assign(initialize, staticMethods, {
	load,
	// `_root` and `_options` are used in static methods.
	_root: initialRoot,
	_options: internalOpts,
	// Add `fn` for plugins
	fn: LoadedCheerio.prototype,
	// Add the prototype here to maintain `instanceof` behavior.
	prototype: LoadedCheerio.prototype,
	});

	return initialize as CheerioAPI;
	};
	}

	function isNode(obj: any): obj is AnyNode {
	return (
	!!obj.name \|\|
	obj.type === 'root' \|\|
	obj.type === 'text' \|\|
	obj.type === 'comment'
	);
	}