index.d.ts 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. import type { CompiledQuery, Options, Query, Adapter } from "./types";
  2. export type { Options };
  3. /**
  4. * Compiles the query, returns a function.
  5. */
  6. export declare const compile: <Node_1, ElementNode extends Node_1>(selector: string | import("css-what").Selector[][], options?: Options<Node_1, ElementNode> | undefined, context?: Node_1 | Node_1[] | undefined) => CompiledQuery<Node_1>;
  7. export declare const _compileUnsafe: <Node_1, ElementNode extends Node_1>(selector: string | import("css-what").Selector[][], options?: Options<Node_1, ElementNode> | undefined, context?: Node_1 | Node_1[] | undefined) => CompiledQuery<ElementNode>;
  8. export declare const _compileToken: <Node_1, ElementNode extends Node_1>(selector: import("./types").InternalSelector[][], options?: Options<Node_1, ElementNode> | undefined, context?: Node_1 | Node_1[] | undefined) => CompiledQuery<ElementNode>;
  9. export declare function prepareContext<Node, ElementNode extends Node>(elems: Node | Node[], adapter: Adapter<Node, ElementNode>, shouldTestNextSiblings?: boolean): Node[];
  10. /**
  11. * @template Node The generic Node type for the DOM adapter being used.
  12. * @template ElementNode The Node type for elements for the DOM adapter being used.
  13. * @param elems Elements to query. If it is an element, its children will be queried..
  14. * @param query can be either a CSS selector string or a compiled query function.
  15. * @param [options] options for querying the document.
  16. * @see compile for supported selector queries.
  17. * @returns All matching elements.
  18. *
  19. */
  20. export declare const selectAll: <Node_1, ElementNode extends Node_1>(query: Query<ElementNode>, elements: Node_1 | Node_1[], options?: Options<Node_1, ElementNode> | undefined) => ElementNode[];
  21. /**
  22. * @template Node The generic Node type for the DOM adapter being used.
  23. * @template ElementNode The Node type for elements for the DOM adapter being used.
  24. * @param elems Elements to query. If it is an element, its children will be queried..
  25. * @param query can be either a CSS selector string or a compiled query function.
  26. * @param [options] options for querying the document.
  27. * @see compile for supported selector queries.
  28. * @returns the first match, or null if there was no match.
  29. */
  30. export declare const selectOne: <Node_1, ElementNode extends Node_1>(query: Query<ElementNode>, elements: Node_1 | Node_1[], options?: Options<Node_1, ElementNode> | undefined) => ElementNode | null;
  31. /**
  32. * Tests whether or not an element is matched by query.
  33. *
  34. * @template Node The generic Node type for the DOM adapter being used.
  35. * @template ElementNode The Node type for elements for the DOM adapter being used.
  36. * @param elem The element to test if it matches the query.
  37. * @param query can be either a CSS selector string or a compiled query function.
  38. * @param [options] options for querying the document.
  39. * @see compile for supported selector queries.
  40. * @returns
  41. */
  42. export declare function is<Node, ElementNode extends Node>(elem: ElementNode, query: Query<ElementNode>, options?: Options<Node, ElementNode>): boolean;
  43. /**
  44. * Alias for selectAll(query, elems, options).
  45. * @see [compile] for supported selector queries.
  46. */
  47. export default selectAll;
  48. export { filters, pseudos, aliases } from "./pseudo-selectors";
  49. //# sourceMappingURL=index.d.ts.map