FeedHandler.d.ts 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. import DomHandler, { DomHandlerOptions } from "domhandler";
  2. import { ParserOptions } from "./Parser";
  3. declare enum FeedItemMediaMedium {
  4. image = 0,
  5. audio = 1,
  6. video = 2,
  7. document = 3,
  8. executable = 4
  9. }
  10. declare enum FeedItemMediaExpression {
  11. sample = 0,
  12. full = 1,
  13. nonstop = 2
  14. }
  15. interface FeedItemMedia {
  16. url?: string;
  17. fileSize?: number;
  18. type?: string;
  19. medium: FeedItemMediaMedium | undefined;
  20. isDefault: boolean;
  21. expression?: FeedItemMediaExpression;
  22. bitrate?: number;
  23. framerate?: number;
  24. samplingrate?: number;
  25. channels?: number;
  26. duration?: number;
  27. height?: number;
  28. width?: number;
  29. lang?: string;
  30. }
  31. interface FeedItem {
  32. id?: string;
  33. title?: string;
  34. link?: string;
  35. description?: string;
  36. pubDate?: Date;
  37. media?: FeedItemMedia[];
  38. }
  39. interface Feed {
  40. type?: string;
  41. id?: string;
  42. title?: string;
  43. link?: string;
  44. description?: string;
  45. updated?: Date;
  46. author?: string;
  47. items?: FeedItem[];
  48. }
  49. export declare class FeedHandler extends DomHandler {
  50. feed?: Feed;
  51. /**
  52. *
  53. * @param callback
  54. * @param options
  55. */
  56. constructor(callback?: ((error: Error | null) => void) | DomHandlerOptions, options?: DomHandlerOptions);
  57. onend(): void;
  58. }
  59. /**
  60. * Parse a feed.
  61. *
  62. * @param feed The feed that should be parsed, as a string.
  63. * @param options Optionally, options for parsing. When using this option, you should set `xmlMode` to `true`.
  64. */
  65. export declare function parseFeed(feed: string, options?: ParserOptions & DomHandlerOptions): Feed | undefined;
  66. export {};
  67. //# sourceMappingURL=FeedHandler.d.ts.map