summaryrefslogtreecommitdiff
path: root/includes/external/addressbook/node_modules/cheerio/lib/api/traversing.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'includes/external/addressbook/node_modules/cheerio/lib/api/traversing.d.ts')
-rw-r--r--includes/external/addressbook/node_modules/cheerio/lib/api/traversing.d.ts644
1 files changed, 0 insertions, 644 deletions
diff --git a/includes/external/addressbook/node_modules/cheerio/lib/api/traversing.d.ts b/includes/external/addressbook/node_modules/cheerio/lib/api/traversing.d.ts
deleted file mode 100644
index 614c0ae..0000000
--- a/includes/external/addressbook/node_modules/cheerio/lib/api/traversing.d.ts
+++ /dev/null
@@ -1,644 +0,0 @@
-/**
- * Methods for traversing the DOM structure.
- *
- * @module cheerio/traversing
- */
-import { AnyNode, Element, Document } from 'domhandler';
-import type { Cheerio } from '../cheerio.js';
-import type { AcceptedFilters } from '../types.js';
-/**
- * Get the descendants of each element in the current set of matched elements,
- * filtered by a selector, jQuery object, or element.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('#fruits').find('li').length;
- * //=> 3
- * $('#fruits').find($('.apple')).length;
- * //=> 1
- * ```
- *
- * @param selectorOrHaystack - Element to look for.
- * @returns The found elements.
- * @see {@link https://api.jquery.com/find/}
- */
-export declare function find<T extends AnyNode>(this: Cheerio<T>, selectorOrHaystack?: string | Cheerio<Element> | Element): Cheerio<Element>;
-/**
- * Get the parent of each element in the current set of matched elements,
- * optionally filtered by a selector.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('.pear').parent().attr('id');
- * //=> fruits
- * ```
- *
- * @param selector - If specified filter for parent.
- * @returns The parents.
- * @see {@link https://api.jquery.com/parent/}
- */
-export declare const parent: <T extends AnyNode>(this: Cheerio<T>, selector?: AcceptedFilters<Element>) => Cheerio<Element>;
-/**
- * Get a set of parents filtered by `selector` of each element in the current
- * set of match elements.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('.orange').parents().length;
- * //=> 2
- * $('.orange').parents('#fruits').length;
- * //=> 1
- * ```
- *
- * @param selector - If specified filter for parents.
- * @returns The parents.
- * @see {@link https://api.jquery.com/parents/}
- */
-export declare const parents: <T extends AnyNode>(this: Cheerio<T>, selector?: AcceptedFilters<Element>) => Cheerio<Element>;
-/**
- * Get the ancestors of each element in the current set of matched elements, up
- * to but not including the element matched by the selector, DOM node, or cheerio object.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('.orange').parentsUntil('#food').length;
- * //=> 1
- * ```
- *
- * @param selector - Selector for element to stop at.
- * @param filterSelector - Optional filter for parents.
- * @returns The parents.
- * @see {@link https://api.jquery.com/parentsUntil/}
- */
-export declare const parentsUntil: <T extends AnyNode>(this: Cheerio<T>, selector?: AcceptedFilters<Element> | null, filterSelector?: AcceptedFilters<Element>) => Cheerio<Element>;
-/**
- * For each element in the set, get the first element that matches the selector
- * by testing the element itself and traversing up through its ancestors in the DOM tree.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('.orange').closest();
- * //=> []
- *
- * $('.orange').closest('.apple');
- * // => []
- *
- * $('.orange').closest('li');
- * //=> [<li class="orange">Orange</li>]
- *
- * $('.orange').closest('#fruits');
- * //=> [<ul id="fruits"> ... </ul>]
- * ```
- *
- * @param selector - Selector for the element to find.
- * @returns The closest nodes.
- * @see {@link https://api.jquery.com/closest/}
- */
-export declare function closest<T extends AnyNode>(this: Cheerio<T>, selector?: AcceptedFilters<Element>): Cheerio<AnyNode>;
-/**
- * Gets the next sibling of the first selected element, optionally filtered by a selector.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('.apple').next().hasClass('orange');
- * //=> true
- * ```
- *
- * @param selector - If specified filter for sibling.
- * @returns The next nodes.
- * @see {@link https://api.jquery.com/next/}
- */
-export declare const next: <T extends AnyNode>(this: Cheerio<T>, selector?: AcceptedFilters<Element>) => Cheerio<Element>;
-/**
- * Gets all the following siblings of the first selected element, optionally
- * filtered by a selector.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('.apple').nextAll();
- * //=> [<li class="orange">Orange</li>, <li class="pear">Pear</li>]
- * $('.apple').nextAll('.orange');
- * //=> [<li class="orange">Orange</li>]
- * ```
- *
- * @param selector - If specified filter for siblings.
- * @returns The next nodes.
- * @see {@link https://api.jquery.com/nextAll/}
- */
-export declare const nextAll: <T extends AnyNode>(this: Cheerio<T>, selector?: AcceptedFilters<Element>) => Cheerio<Element>;
-/**
- * Gets all the following siblings up to but not including the element matched
- * by the selector, optionally filtered by another selector.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('.apple').nextUntil('.pear');
- * //=> [<li class="orange">Orange</li>]
- * ```
- *
- * @param selector - Selector for element to stop at.
- * @param filterSelector - If specified filter for siblings.
- * @returns The next nodes.
- * @see {@link https://api.jquery.com/nextUntil/}
- */
-export declare const nextUntil: <T extends AnyNode>(this: Cheerio<T>, selector?: AcceptedFilters<Element> | null, filterSelector?: AcceptedFilters<Element>) => Cheerio<Element>;
-/**
- * Gets the previous sibling of the first selected element optionally filtered
- * by a selector.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('.orange').prev().hasClass('apple');
- * //=> true
- * ```
- *
- * @param selector - If specified filter for siblings.
- * @returns The previous nodes.
- * @see {@link https://api.jquery.com/prev/}
- */
-export declare const prev: <T extends AnyNode>(this: Cheerio<T>, selector?: AcceptedFilters<Element>) => Cheerio<Element>;
-/**
- * Gets all the preceding siblings of the first selected element, optionally
- * filtered by a selector.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('.pear').prevAll();
- * //=> [<li class="orange">Orange</li>, <li class="apple">Apple</li>]
- *
- * $('.pear').prevAll('.orange');
- * //=> [<li class="orange">Orange</li>]
- * ```
- *
- * @param selector - If specified filter for siblings.
- * @returns The previous nodes.
- * @see {@link https://api.jquery.com/prevAll/}
- */
-export declare const prevAll: <T extends AnyNode>(this: Cheerio<T>, selector?: AcceptedFilters<Element>) => Cheerio<Element>;
-/**
- * Gets all the preceding siblings up to but not including the element matched
- * by the selector, optionally filtered by another selector.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('.pear').prevUntil('.apple');
- * //=> [<li class="orange">Orange</li>]
- * ```
- *
- * @param selector - Selector for element to stop at.
- * @param filterSelector - If specified filter for siblings.
- * @returns The previous nodes.
- * @see {@link https://api.jquery.com/prevUntil/}
- */
-export declare const prevUntil: <T extends AnyNode>(this: Cheerio<T>, selector?: AcceptedFilters<Element> | null, filterSelector?: AcceptedFilters<Element>) => Cheerio<Element>;
-/**
- * Get the siblings of each element (excluding the element) in the set of
- * matched elements, optionally filtered by a selector.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('.pear').siblings().length;
- * //=> 2
- *
- * $('.pear').siblings('.orange').length;
- * //=> 1
- * ```
- *
- * @param selector - If specified filter for siblings.
- * @returns The siblings.
- * @see {@link https://api.jquery.com/siblings/}
- */
-export declare const siblings: <T extends AnyNode>(this: Cheerio<T>, selector?: AcceptedFilters<Element>) => Cheerio<Element>;
-/**
- * Gets the element children of each element in the set of matched elements.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('#fruits').children().length;
- * //=> 3
- *
- * $('#fruits').children('.pear').text();
- * //=> Pear
- * ```
- *
- * @param selector - If specified filter for children.
- * @returns The children.
- * @see {@link https://api.jquery.com/children/}
- */
-export declare const children: <T extends AnyNode>(this: Cheerio<T>, selector?: AcceptedFilters<Element>) => Cheerio<Element>;
-/**
- * Gets the children of each element in the set of matched elements, including
- * text and comment nodes.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('#fruits').contents().length;
- * //=> 3
- * ```
- *
- * @returns The children.
- * @see {@link https://api.jquery.com/contents/}
- */
-export declare function contents<T extends AnyNode>(this: Cheerio<T>): Cheerio<AnyNode>;
-/**
- * Iterates over a cheerio object, executing a function for each matched
- * element. When the callback is fired, the function is fired in the context of
- * the DOM element, so `this` refers to the current element, which is equivalent
- * to the function parameter `element`. To break out of the `each` loop early,
- * return with `false`.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * const fruits = [];
- *
- * $('li').each(function (i, elem) {
- * fruits[i] = $(this).text();
- * });
- *
- * fruits.join(', ');
- * //=> Apple, Orange, Pear
- * ```
- *
- * @param fn - Function to execute.
- * @returns The instance itself, useful for chaining.
- * @see {@link https://api.jquery.com/each/}
- */
-export declare function each<T>(this: Cheerio<T>, fn: (this: T, i: number, el: T) => void | boolean): Cheerio<T>;
-/**
- * Pass each element in the current matched set through a function, producing a
- * new Cheerio object containing the return values. The function can return an
- * individual data item or an array of data items to be inserted into the
- * resulting set. If an array is returned, the elements inside the array are
- * inserted into the set. If the function returns null or undefined, no element
- * will be inserted.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('li')
- * .map(function (i, el) {
- * // this === el
- * return $(this).text();
- * })
- * .toArray()
- * .join(' ');
- * //=> "apple orange pear"
- * ```
- *
- * @param fn - Function to execute.
- * @returns The mapped elements, wrapped in a Cheerio collection.
- * @see {@link https://api.jquery.com/map/}
- */
-export declare function map<T, M>(this: Cheerio<T>, fn: (this: T, i: number, el: T) => M[] | M | null | undefined): Cheerio<M>;
-/**
- * Iterates over a cheerio object, reducing the set of selector elements to
- * those that match the selector or pass the function's test.
- *
- * This is the definition for using type guards; have a look below for other
- * ways to invoke this method. The function is executed in the context of the
- * selected element, so `this` refers to the current element.
- *
- * @category Traversing
- * @example <caption>Function</caption>
- *
- * ```js
- * $('li')
- * .filter(function (i, el) {
- * // this === el
- * return $(this).attr('class') === 'orange';
- * })
- * .attr('class'); //=> orange
- * ```
- *
- * @param match - Value to look for, following the rules above.
- * @returns The filtered collection.
- * @see {@link https://api.jquery.com/filter/}
- */
-export declare function filter<T, S extends T>(this: Cheerio<T>, match: (this: T, index: number, value: T) => value is S): Cheerio<S>;
-/**
- * Iterates over a cheerio object, reducing the set of selector elements to
- * those that match the selector or pass the function's test.
- *
- * - When a Cheerio selection is specified, return only the elements contained in
- * that selection.
- * - When an element is specified, return only that element (if it is contained in
- * the original selection).
- * - If using the function method, the function is executed in the context of the
- * selected element, so `this` refers to the current element.
- *
- * @category Traversing
- * @example <caption>Selector</caption>
- *
- * ```js
- * $('li').filter('.orange').attr('class');
- * //=> orange
- * ```
- *
- * @example <caption>Function</caption>
- *
- * ```js
- * $('li')
- * .filter(function (i, el) {
- * // this === el
- * return $(this).attr('class') === 'orange';
- * })
- * .attr('class'); //=> orange
- * ```
- *
- * @param match - Value to look for, following the rules above. See
- * {@link AcceptedFilters}.
- * @returns The filtered collection.
- * @see {@link https://api.jquery.com/filter/}
- */
-export declare function filter<T, S extends AcceptedFilters<T>>(this: Cheerio<T>, match: S): Cheerio<S extends string ? Element : T>;
-export declare function filterArray<T>(nodes: T[], match: AcceptedFilters<T>, xmlMode?: boolean, root?: Document): Element[] | T[];
-/**
- * Checks the current list of elements and returns `true` if _any_ of the
- * elements match the selector. If using an element or Cheerio selection,
- * returns `true` if _any_ of the elements match. If using a predicate function,
- * the function is executed in the context of the selected element, so `this`
- * refers to the current element.
- *
- * @category Attributes
- * @param selector - Selector for the selection.
- * @returns Whether or not the selector matches an element of the instance.
- * @see {@link https://api.jquery.com/is/}
- */
-export declare function is<T>(this: Cheerio<T>, selector?: AcceptedFilters<T>): boolean;
-/**
- * Remove elements from the set of matched elements. Given a Cheerio object that
- * represents a set of DOM elements, the `.not()` method constructs a new
- * Cheerio object from a subset of the matching elements. The supplied selector
- * is tested against each element; the elements that don't match the selector
- * will be included in the result.
- *
- * The `.not()` method can take a function as its argument in the same way that
- * `.filter()` does. Elements for which the function returns `true` are excluded
- * from the filtered set; all other elements are included.
- *
- * @category Traversing
- * @example <caption>Selector</caption>
- *
- * ```js
- * $('li').not('.apple').length;
- * //=> 2
- * ```
- *
- * @example <caption>Function</caption>
- *
- * ```js
- * $('li').not(function (i, el) {
- * // this === el
- * return $(this).attr('class') === 'orange';
- * }).length; //=> 2
- * ```
- *
- * @param match - Value to look for, following the rules above.
- * @param container - Optional node to filter instead.
- * @returns The filtered collection.
- * @see {@link https://api.jquery.com/not/}
- */
-export declare function not<T extends AnyNode>(this: Cheerio<T>, match: AcceptedFilters<T>): Cheerio<T>;
-/**
- * Filters the set of matched elements to only those which have the given DOM
- * element as a descendant or which have a descendant that matches the given
- * selector. Equivalent to `.filter(':has(selector)')`.
- *
- * @category Traversing
- * @example <caption>Selector</caption>
- *
- * ```js
- * $('ul').has('.pear').attr('id');
- * //=> fruits
- * ```
- *
- * @example <caption>Element</caption>
- *
- * ```js
- * $('ul').has($('.pear')[0]).attr('id');
- * //=> fruits
- * ```
- *
- * @param selectorOrHaystack - Element to look for.
- * @returns The filtered collection.
- * @see {@link https://api.jquery.com/has/}
- */
-export declare function has(this: Cheerio<AnyNode | Element>, selectorOrHaystack: string | Cheerio<Element> | Element): Cheerio<AnyNode | Element>;
-/**
- * Will select the first element of a cheerio object.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('#fruits').children().first().text();
- * //=> Apple
- * ```
- *
- * @returns The first element.
- * @see {@link https://api.jquery.com/first/}
- */
-export declare function first<T extends AnyNode>(this: Cheerio<T>): Cheerio<T>;
-/**
- * Will select the last element of a cheerio object.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('#fruits').children().last().text();
- * //=> Pear
- * ```
- *
- * @returns The last element.
- * @see {@link https://api.jquery.com/last/}
- */
-export declare function last<T>(this: Cheerio<T>): Cheerio<T>;
-/**
- * Reduce the set of matched elements to the one at the specified index. Use
- * `.eq(-i)` to count backwards from the last selected element.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('li').eq(0).text();
- * //=> Apple
- *
- * $('li').eq(-1).text();
- * //=> Pear
- * ```
- *
- * @param i - Index of the element to select.
- * @returns The element at the `i`th position.
- * @see {@link https://api.jquery.com/eq/}
- */
-export declare function eq<T>(this: Cheerio<T>, i: number): Cheerio<T>;
-/**
- * Retrieve one of the elements matched by the Cheerio object, at the `i`th position.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('li').get(0).tagName;
- * //=> li
- * ```
- *
- * @param i - Element to retrieve.
- * @returns The element at the `i`th position.
- * @see {@link https://api.jquery.com/get/}
- */
-export declare function get<T>(this: Cheerio<T>, i: number): T | undefined;
-/**
- * Retrieve all elements matched by the Cheerio object, as an array.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('li').get().length;
- * //=> 3
- * ```
- *
- * @returns All elements matched by the Cheerio object.
- * @see {@link https://api.jquery.com/get/}
- */
-export declare function get<T>(this: Cheerio<T>): T[];
-/**
- * Retrieve all the DOM elements contained in the jQuery set as an array.
- *
- * @example
- *
- * ```js
- * $('li').toArray();
- * //=> [ {...}, {...}, {...} ]
- * ```
- *
- * @returns The contained items.
- */
-export declare function toArray<T>(this: Cheerio<T>): T[];
-/**
- * Search for a given element from among the matched elements.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('.pear').index();
- * //=> 2 $('.orange').index('li');
- * //=> 1
- * $('.apple').index($('#fruit, li'));
- * //=> 1
- * ```
- *
- * @param selectorOrNeedle - Element to look for.
- * @returns The index of the element.
- * @see {@link https://api.jquery.com/index/}
- */
-export declare function index<T extends AnyNode>(this: Cheerio<T>, selectorOrNeedle?: string | Cheerio<AnyNode> | AnyNode): number;
-/**
- * Gets the elements matching the specified range (0-based position).
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('li').slice(1).eq(0).text();
- * //=> 'Orange'
- *
- * $('li').slice(1, 2).length;
- * //=> 1
- * ```
- *
- * @param start - A position at which the elements begin to be selected. If
- * negative, it indicates an offset from the end of the set.
- * @param end - A position at which the elements stop being selected. If
- * negative, it indicates an offset from the end of the set. If omitted, the
- * range continues until the end of the set.
- * @returns The elements matching the specified range.
- * @see {@link https://api.jquery.com/slice/}
- */
-export declare function slice<T>(this: Cheerio<T>, start?: number, end?: number): Cheerio<T>;
-/**
- * End the most recent filtering operation in the current chain and return the
- * set of matched elements to its previous state.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('li').eq(0).end().length;
- * //=> 3
- * ```
- *
- * @returns The previous state of the set of matched elements.
- * @see {@link https://api.jquery.com/end/}
- */
-export declare function end<T>(this: Cheerio<T>): Cheerio<AnyNode>;
-/**
- * Add elements to the set of matched elements.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('.apple').add('.orange').length;
- * //=> 2
- * ```
- *
- * @param other - Elements to add.
- * @param context - Optionally the context of the new selection.
- * @returns The combined set.
- * @see {@link https://api.jquery.com/add/}
- */
-export declare function add<S extends AnyNode, T extends AnyNode>(this: Cheerio<T>, other: string | Cheerio<S> | S | S[], context?: Cheerio<S> | string): Cheerio<S | T>;
-/**
- * Add the previous set of elements on the stack to the current set, optionally
- * filtered by a selector.
- *
- * @category Traversing
- * @example
- *
- * ```js
- * $('li').eq(0).addBack('.orange').length;
- * //=> 2
- * ```
- *
- * @param selector - Selector for the elements to add.
- * @returns The combined set.
- * @see {@link https://api.jquery.com/addBack/}
- */
-export declare function addBack<T extends AnyNode>(this: Cheerio<T>, selector?: string): Cheerio<AnyNode>;
-//# sourceMappingURL=traversing.d.ts.map \ No newline at end of file