index.d.ts 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. import { Parser, ParserOptions } from "./Parser.js";
  2. export { Parser, type ParserOptions } from "./Parser.js";
  3. import { DomHandlerOptions, ChildNode, Element, Document } from "domhandler";
  4. export { DomHandler, DomHandler as DefaultHandler, type DomHandlerOptions, } from "domhandler";
  5. export type Options = ParserOptions & DomHandlerOptions;
  6. /**
  7. * Parses the data, returns the resulting document.
  8. *
  9. * @param data The data that should be parsed.
  10. * @param options Optional options for the parser and DOM builder.
  11. */
  12. export declare function parseDocument(data: string, options?: Options): Document;
  13. /**
  14. * Parses data, returns an array of the root nodes.
  15. *
  16. * Note that the root nodes still have a `Document` node as their parent.
  17. * Use `parseDocument` to get the `Document` node instead.
  18. *
  19. * @param data The data that should be parsed.
  20. * @param options Optional options for the parser and DOM builder.
  21. * @deprecated Use `parseDocument` instead.
  22. */
  23. export declare function parseDOM(data: string, options?: Options): ChildNode[];
  24. /**
  25. * Creates a parser instance, with an attached DOM handler.
  26. *
  27. * @param callback A callback that will be called once parsing has been completed.
  28. * @param options Optional options for the parser and DOM builder.
  29. * @param elementCallback An optional callback that will be called every time a tag has been completed inside of the DOM.
  30. */
  31. export declare function createDomStream(callback: (error: Error | null, dom: ChildNode[]) => void, options?: Options, elementCallback?: (element: Element) => void): Parser;
  32. export { default as Tokenizer, type Callbacks as TokenizerCallbacks, } from "./Tokenizer.js";
  33. export * as ElementType from "domelementtype";
  34. import { Feed } from "domutils";
  35. export { getFeed } from "domutils";
  36. /**
  37. * Parse a feed.
  38. *
  39. * @param feed The feed that should be parsed, as a string.
  40. * @param options Optionally, options for parsing. When using this, you should set `xmlMode` to `true`.
  41. */
  42. export declare function parseFeed(feed: string, options?: Options): Feed | null;
  43. export * as DomUtils from "domutils";
  44. //# sourceMappingURL=index.d.ts.map