breaking: Remove FeedHandler class (#1166)

Author: fb55

src/FeedHandler.spec.ts

@@ -1,16 +1,16 @@
 // Runs tests for feeds
 
 import * as helper from "./__fixtures__/test-helper";
-import { FeedHandler, parseFeed } from "./FeedHandler";
+import { DomHandler, getFeed, parseFeed } from ".";
 import fs from "fs";
 import path from "path";
 
 const documents = path.join(__dirname, "__fixtures__", "Documents");
 
 helper.createSuite("Feeds", (test, cb) => {
     const file = fs.readFileSync(path.join(documents, test.file), "utf8");
-    const handler: FeedHandler = new FeedHandler((err) =>
-        cb(err, handler.feed)
+    const handler: DomHandler = new DomHandler((err) =>
+        cb(err, getFeed(handler.dom))
     );
 
     helper.writeToParser(handler, { xmlMode: true }, file);

src/FeedHandler.ts

@@ -4,9 +4,7 @@ import {
     createDomStream,
     DomHandler,
     DefaultHandler,
-    RssHandler,
 } from ".";
-import { FeedHandler } from "./FeedHandler";
 import { Element } from "domhandler";
 
 // Add an `attributes` prop to the Element for now, to make it possible for Jest to render DOM nodes.
@@ -49,7 +47,6 @@ describe("Index", () => {
 
     describe("API", () => {
         it("should export the appropriate APIs", () => {
-            expect(RssHandler).toEqual(FeedHandler);
             expect(DomHandler).toEqual(DefaultHandler);
         });
     });

src/index.spec.ts

@@ -59,17 +59,32 @@ export {
     default as Tokenizer,
     type Callbacks as TokenizerCallbacks,
 } from "./Tokenizer.js";
-import * as ElementType from "domelementtype";
-export { ElementType };
 
 /*
  * All of the following exports exist for backwards-compatibility.
  * They should probably be removed eventually.
  */
+import * as ElementType from "domelementtype";
+export { ElementType };
+
+import { getFeed, Feed } from "domutils";
+
+export { getFeed };
+
+/**
+ * Parse a feed.
+ *
+ * @param feed The feed that should be parsed, as a string.
+ * @param options Optionally, options for parsing. When using this, you should set `xmlMode` to `true`.
+ */
+export function parseFeed(
+    feed: string,
+    options: ParserOptions & DomHandlerOptions = { xmlMode: true }
+): Feed | null {
+    return getFeed(parseDOM(feed, options));
+}
 
-export * from "./FeedHandler.js";
 export * as DomUtils from "domutils";
 
-// Old names for Dom- & FeedHandler
+// Old name for DomHandler
 export { DomHandler as DefaultHandler };
-export { FeedHandler as RssHandler } from "./FeedHandler.js";