123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204 |
- import { textContent } from 'domutils';
- import { flattenOptions as flattenOptions, } from './options.js';
- /**
- * Helper function to render a DOM.
- *
- * @param that - Cheerio instance to render.
- * @param dom - The DOM to render. Defaults to `that`'s root.
- * @param options - Options for rendering.
- * @returns The rendered document.
- */
- function render(that, dom, options) {
- if (!that)
- return '';
- return that(dom !== null && dom !== void 0 ? dom : that._root.children, null, undefined, options).toString();
- }
- /**
- * Checks if a passed object is an options object.
- *
- * @param dom - Object to check if it is an options object.
- * @param options - Options object.
- * @returns Whether the object is an options object.
- */
- function isOptions(dom, options) {
- return (!options &&
- typeof dom === 'object' &&
- dom != null &&
- !('length' in dom) &&
- !('type' in dom));
- }
- export function html(dom, options) {
- /*
- * Be flexible about parameters, sometimes we call html(),
- * with options as only parameter
- * check dom argument for dom element specific properties
- * assume there is no 'length' or 'type' properties in the options object
- */
- const toRender = isOptions(dom) ? ((options = dom), undefined) : dom;
- /*
- * Sometimes `$.html()` is used without preloading html,
- * so fallback non-existing options to the default ones.
- */
- const opts = {
- ...this === null || this === void 0 ? void 0 : this._options,
- ...flattenOptions(options),
- };
- return render(this, toRender, opts);
- }
- /**
- * Render the document as XML.
- *
- * @category Static
- * @param dom - Element to render.
- * @returns THe rendered document.
- */
- export function xml(dom) {
- const options = { ...this._options, xmlMode: true };
- return render(this, dom, options);
- }
- /**
- * Render the document as text.
- *
- * This returns the `textContent` of the passed elements. The result will
- * include the contents of `<script>` and `<style>` elements. To avoid this, use
- * `.prop('innerText')` instead.
- *
- * @category Static
- * @param elements - Elements to render.
- * @returns The rendered document.
- */
- export function text(elements) {
- const elems = elements !== null && elements !== void 0 ? elements : (this ? this.root() : []);
- let ret = '';
- for (let i = 0; i < elems.length; i++) {
- ret += textContent(elems[i]);
- }
- return ret;
- }
- export function parseHTML(data, context, keepScripts = typeof context === 'boolean' ? context : false) {
- if (!data || typeof data !== 'string') {
- return null;
- }
- if (typeof context === 'boolean') {
- keepScripts = context;
- }
- const parsed = this.load(data, this._options, false);
- if (!keepScripts) {
- parsed('script').remove();
- }
- /*
- * The `children` array is used by Cheerio internally to group elements that
- * share the same parents. When nodes created through `parseHTML` are
- * inserted into previously-existing DOM structures, they will be removed
- * from the `children` array. The results of `parseHTML` should remain
- * constant across these operations, so a shallow copy should be returned.
- */
- return [...parsed.root()[0].children];
- }
- /**
- * Sometimes you need to work with the top-level root element. To query it, you
- * can use `$.root()`.
- *
- * @category Static
- * @example
- *
- * ```js
- * $.root().append('<ul id="vegetables"></ul>').html();
- * //=> <ul id="fruits">...</ul><ul id="vegetables"></ul>
- * ```
- *
- * @returns Cheerio instance wrapping the root node.
- * @alias Cheerio.root
- */
- export function root() {
- return this(this._root);
- }
- /**
- * Checks to see if the `contained` DOM element is a descendant of the
- * `container` DOM element.
- *
- * @category Static
- * @param container - Potential parent node.
- * @param contained - Potential child node.
- * @returns Indicates if the nodes contain one another.
- * @alias Cheerio.contains
- * @see {@link https://api.jquery.com/jQuery.contains/}
- */
- export function contains(container, contained) {
- // According to the jQuery API, an element does not "contain" itself
- if (contained === container) {
- return false;
- }
- /*
- * Step up the descendants, stopping when the root element is reached
- * (signaled by `.parent` returning a reference to the same object)
- */
- let next = contained;
- while (next && next !== next.parent) {
- next = next.parent;
- if (next === container) {
- return true;
- }
- }
- return false;
- }
- /**
- * Extract multiple values from a document, and store them in an object.
- *
- * @category Static
- * @param map - An object containing key-value pairs. The keys are the names of
- * the properties to be created on the object, and the values are the
- * selectors to be used to extract the values.
- * @returns An object containing the extracted values.
- */
- export function extract(map) {
- return this.root().extract(map);
- }
- /**
- * $.merge().
- *
- * @category Static
- * @param arr1 - First array.
- * @param arr2 - Second array.
- * @returns `arr1`, with elements of `arr2` inserted.
- * @alias Cheerio.merge
- * @see {@link https://api.jquery.com/jQuery.merge/}
- */
- export function merge(arr1, arr2) {
- if (!isArrayLike(arr1) || !isArrayLike(arr2)) {
- return;
- }
- let newLength = arr1.length;
- const len = +arr2.length;
- for (let i = 0; i < len; i++) {
- arr1[newLength++] = arr2[i];
- }
- arr1.length = newLength;
- return arr1;
- }
- /**
- * Checks if an object is array-like.
- *
- * @category Static
- * @param item - Item to check.
- * @returns Indicates if the item is array-like.
- */
- function isArrayLike(item) {
- if (Array.isArray(item)) {
- return true;
- }
- if (typeof item !== 'object' ||
- item === null ||
- !('length' in item) ||
- typeof item.length !== 'number' ||
- item.length < 0) {
- return false;
- }
- for (let i = 0; i < item.length; i++) {
- if (!(i in item)) {
- return false;
- }
- }
- return true;
- }
- //# sourceMappingURL=static.js.map
|