v6.2.1rc2

- Add ts types
- Update examples

Author: ndaidong

examples/bun-feed-reader/README.md

@@ -17,18 +17,15 @@ Open `http://localhost:3103/?url=https://news.google.com/rss` to see the result.
 
 You can specify the following options via query string parameters:
 
-- `includeEntryContent`
-- `includeOptionalElements`
-- `useISODateFormat`
 - `normalization`
+- `useISODateFormat`
 
 These params can be set to  `y` or `n`, with `y` is truthy, `n` is falsy.
 
 For examples:
 
 ```
-http://localhost:3103/?url=https://news.google.com/rss&includeEntryContent=y&useISODateFormat=n&includeOptionalElements=y
+http://localhost:3103/?normalization=y&useISODateFormat=y&url=https://news.google.com/rss
 ```
 
-
 ---

examples/deno-feed-reader/README.md

@@ -11,17 +11,15 @@ Open `http://localhost:3103/?url=https://news.google.com/rss` to see the result.
 
 You can specify the following options via query string parameters:
 
-- `includeEntryContent`
-- `includeOptionalElements`
-- `useISODateFormat`
 - `normalization`
+- `useISODateFormat`
 
 These params can be set to  `y` or `n`, with `y` is truthy, `n` is falsy.
 
 For examples:
 
 ```
-http://localhost:3103/?url=https://news.google.com/rss&includeEntryContent=y&useISODateFormat=n&includeOptionalElements=y
+http://localhost:3103/?normalization=y&useISODateFormat=y&url=https://news.google.com/rss
 ```
 
 ---

examples/node-feed-reader/README.md

@@ -19,17 +19,15 @@ Open `http://localhost:3103/?url=https://news.google.com/rss` to see the result.
 
 You can specify the following options via query string parameters:
 
-- `includeEntryContent`
-- `includeOptionalElements`
-- `useISODateFormat`
 - `normalization`
+- `useISODateFormat`
 
 These params can be set to  `y` or `n`, with `y` is truthy, `n` is falsy.
 
 For examples:
 
 ```
-http://localhost:3103/?url=https://news.google.com/rss&includeEntryContent=y&useISODateFormat=n&includeOptionalElements=y
+http://localhost:3103/?normalization=y&useISODateFormat=y&url=https://news.google.com/rss
 ```
 
 ---

examples/node-feed-reader/package.json

@@ -8,6 +8,6 @@
   },
   "dependencies": {
     "@extractus/feed-extractor": "latest",
-    "express": "^4.18.1"
+    "express": "^4.18.2"
   }
 }

examples/tsnode-feed-reader/package.json

@@ -7,10 +7,10 @@
     "start": "node dist/index.js"
   },
   "devDependencies": {
-    "typescript": "^4.8.3"
+    "typescript": "^4.9.4"
   },
   "dependencies": {
     "@extractus/feed-extractor": "latest",
-    "express": "^4.18.1"
+    "express": "^4.18.2"
   }
 }

index.d.ts

@@ -32,16 +32,6 @@ export interface ReaderOptions {
    * default: true
    */
   normalization?: boolean;
-  /**
-   * include full content of feed entry if present
-   * default: false
-   */
-  includeEntryContent?: boolean;
-  /**
-   * include optional elements if any
-   * default: false
-   */
-  includeOptionalElements?: boolean;
   /**
    * convert datetime to ISO format
    * default: true
@@ -80,4 +70,7 @@ export interface FetchOptions {
   proxy?: ProxyConfig;
 }
 
+export function extractFromXml(xml: string, options?: ReaderOptions): object<FeedData>;
+export function extractFromJson(json: string, options?: ReaderOptions): object<FeedData>;
+export function extract(url: string, options?: ReaderOptions, fetchOptions?: FetchOptions): Promise<FeedData>;
 export function read(url: string, options?: ReaderOptions, fetchOptions?: FetchOptions): Promise<FeedData>;

package.json

@@ -1,5 +1,5 @@
 {
-  "version": "6.2.1rc1",
+  "version": "6.2.1rc2",
   "name": "@extractus/feed-extractor",
   "description": "To read and normalize RSS/ATOM/JSON feed data",
   "homepage": "https://github.com/extractus/feed-extractor",