feedsmith 1.8.0 → 2.0.0-next.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +79 -65
- package/dist/common/config.d.ts +18 -1
- package/dist/common/config.js +25 -0
- package/dist/common/config.js.map +1 -1
- package/dist/common/parse.d.ts +9 -8
- package/dist/common/parse.js.map +1 -1
- package/dist/common/types.d.ts +14 -1
- package/dist/common/utils.d.ts +27 -15
- package/dist/common/utils.js +296 -51
- package/dist/common/utils.js.map +1 -1
- package/dist/feeds/atom/common/types.d.ts +103 -0
- package/dist/feeds/atom/common/types.js.map +1 -0
- package/dist/feeds/atom/detect/index.js +11 -1
- package/dist/feeds/atom/detect/index.js.map +1 -1
- package/dist/feeds/atom/generate/config.d.ts +2 -0
- package/dist/feeds/atom/generate/config.js +6 -0
- package/dist/feeds/atom/generate/config.js.map +1 -0
- package/dist/feeds/atom/generate/index.d.ts +2 -0
- package/dist/feeds/atom/generate/index.js +11 -0
- package/dist/feeds/atom/generate/index.js.map +1 -0
- package/dist/feeds/atom/generate/utils.d.ts +10 -0
- package/dist/feeds/atom/generate/utils.js +182 -0
- package/dist/feeds/atom/generate/utils.js.map +1 -0
- package/dist/feeds/atom/parse/config.js +1 -1
- package/dist/feeds/atom/parse/config.js.map +1 -1
- package/dist/feeds/atom/parse/index.d.ts +3 -2
- package/dist/feeds/atom/parse/index.js +5 -2
- package/dist/feeds/atom/parse/index.js.map +1 -1
- package/dist/feeds/atom/parse/utils.d.ts +16 -15
- package/dist/feeds/atom/parse/utils.js +84 -80
- package/dist/feeds/atom/parse/utils.js.map +1 -1
- package/dist/feeds/json/{generate → common}/types.d.ts +9 -8
- package/dist/feeds/json/common/types.js.map +1 -0
- package/dist/feeds/json/detect/index.js +14 -2
- package/dist/feeds/json/detect/index.js.map +1 -1
- package/dist/feeds/json/generate/index.d.ts +2 -2
- package/dist/feeds/json/generate/index.js.map +1 -1
- package/dist/feeds/json/generate/utils.d.ts +31 -32
- package/dist/feeds/json/generate/utils.js +4 -9
- package/dist/feeds/json/generate/utils.js.map +1 -1
- package/dist/feeds/json/parse/index.d.ts +3 -2
- package/dist/feeds/json/parse/index.js.map +1 -1
- package/dist/feeds/json/parse/utils.d.ts +9 -8
- package/dist/feeds/json/parse/utils.js +34 -29
- package/dist/feeds/json/parse/utils.js.map +1 -1
- package/dist/feeds/rdf/common/types.d.ts +48 -0
- package/dist/feeds/{rss/parse → rdf/common}/types.js.map +1 -1
- package/dist/feeds/rdf/detect/index.js +12 -1
- package/dist/feeds/rdf/detect/index.js.map +1 -1
- package/dist/feeds/rdf/parse/config.js +1 -1
- package/dist/feeds/rdf/parse/config.js.map +1 -1
- package/dist/feeds/rdf/parse/index.d.ts +3 -2
- package/dist/feeds/rdf/parse/index.js +5 -2
- package/dist/feeds/rdf/parse/index.js.map +1 -1
- package/dist/feeds/rdf/parse/utils.d.ts +10 -10
- package/dist/feeds/rdf/parse/utils.js +52 -55
- package/dist/feeds/rdf/parse/utils.js.map +1 -1
- package/dist/feeds/rss/common/types.d.ts +111 -0
- package/dist/feeds/{json/parse → rss/common}/types.js.map +1 -1
- package/dist/feeds/rss/detect/index.js +11 -1
- package/dist/feeds/rss/detect/index.js.map +1 -1
- package/dist/feeds/rss/generate/config.d.ts +2 -0
- package/dist/feeds/rss/generate/config.js +6 -0
- package/dist/feeds/rss/generate/config.js.map +1 -0
- package/dist/feeds/rss/generate/index.d.ts +2 -0
- package/dist/feeds/rss/generate/index.js +11 -0
- package/dist/feeds/rss/generate/index.js.map +1 -0
- package/dist/feeds/rss/generate/utils.d.ts +14 -0
- package/dist/feeds/rss/generate/utils.js +182 -0
- package/dist/feeds/rss/generate/utils.js.map +1 -0
- package/dist/feeds/rss/parse/config.js +1 -1
- package/dist/feeds/rss/parse/config.js.map +1 -1
- package/dist/feeds/rss/parse/index.d.ts +3 -2
- package/dist/feeds/rss/parse/index.js +5 -2
- package/dist/feeds/rss/parse/index.js.map +1 -1
- package/dist/feeds/rss/parse/utils.d.ts +15 -14
- package/dist/feeds/rss/parse/utils.js +101 -108
- package/dist/feeds/rss/parse/utils.js.map +1 -1
- package/dist/index.d.ts +14 -13
- package/dist/index.js +9 -7
- package/dist/index.js.map +1 -1
- package/dist/namespaces/atom/common/types.d.ts +4 -0
- package/dist/namespaces/atom/common/types.js.map +1 -0
- package/dist/namespaces/atom/generate/utils.d.ts +4 -0
- package/dist/namespaces/atom/generate/utils.js +8 -0
- package/dist/namespaces/atom/generate/utils.js.map +1 -0
- package/dist/namespaces/atom/parse/utils.d.ts +4 -0
- package/dist/namespaces/atom/parse/utils.js +8 -0
- package/dist/namespaces/atom/parse/utils.js.map +1 -0
- package/dist/namespaces/content/common/types.js.map +1 -0
- package/dist/namespaces/content/generate/utils.d.ts +3 -0
- package/dist/namespaces/content/generate/utils.js +11 -0
- package/dist/namespaces/content/generate/utils.js.map +1 -0
- package/dist/namespaces/content/parse/utils.d.ts +3 -0
- package/dist/namespaces/content/parse/utils.js +11 -0
- package/dist/namespaces/content/parse/utils.js.map +1 -0
- package/dist/namespaces/dc/{types.d.ts → common/types.d.ts} +3 -2
- package/dist/namespaces/dc/common/types.js.map +1 -0
- package/dist/namespaces/dc/generate/utils.d.ts +3 -0
- package/dist/namespaces/dc/generate/utils.js +25 -0
- package/dist/namespaces/dc/generate/utils.js.map +1 -0
- package/dist/namespaces/dc/parse/utils.d.ts +3 -0
- package/dist/namespaces/dc/parse/utils.js +25 -0
- package/dist/namespaces/dc/parse/utils.js.map +1 -0
- package/dist/namespaces/dcterms/common/types.d.ts +58 -0
- package/dist/namespaces/dcterms/common/types.js.map +1 -0
- package/dist/namespaces/dcterms/generate/utils.d.ts +3 -0
- package/dist/namespaces/dcterms/generate/utils.js +65 -0
- package/dist/namespaces/dcterms/generate/utils.js.map +1 -0
- package/dist/namespaces/dcterms/parse/utils.d.ts +3 -0
- package/dist/namespaces/dcterms/parse/utils.js +65 -0
- package/dist/namespaces/dcterms/parse/utils.js.map +1 -0
- package/dist/namespaces/georss/common/types.d.ts +26 -0
- package/dist/namespaces/georss/common/types.js.map +1 -0
- package/dist/namespaces/georss/generate/utils.d.ts +11 -0
- package/dist/namespaces/georss/generate/utils.js +61 -0
- package/dist/namespaces/georss/generate/utils.js.map +1 -0
- package/dist/namespaces/georss/parse/utils.d.ts +11 -0
- package/dist/namespaces/georss/parse/utils.js +69 -0
- package/dist/namespaces/georss/parse/utils.js.map +1 -0
- package/dist/namespaces/itunes/{types.d.ts → common/types.d.ts} +2 -2
- package/dist/namespaces/itunes/common/types.js.map +1 -0
- package/dist/namespaces/itunes/generate/utils.d.ts +7 -0
- package/dist/namespaces/itunes/generate/utils.js +71 -0
- package/dist/namespaces/itunes/generate/utils.js.map +1 -0
- package/dist/namespaces/itunes/parse/utils.d.ts +9 -0
- package/dist/namespaces/itunes/{utils.js → parse/utils.js} +27 -31
- package/dist/namespaces/itunes/parse/utils.js.map +1 -0
- package/dist/namespaces/media/{types.d.ts → common/types.d.ts} +24 -20
- package/dist/namespaces/media/common/types.js.map +1 -0
- package/dist/namespaces/media/generate/utils.d.ts +33 -0
- package/dist/namespaces/media/generate/utils.js +351 -0
- package/dist/namespaces/media/generate/utils.js.map +1 -0
- package/dist/namespaces/media/parse/utils.d.ts +35 -0
- package/dist/namespaces/media/{utils.js → parse/utils.js} +65 -107
- package/dist/namespaces/media/parse/utils.js.map +1 -0
- package/dist/namespaces/podcast/{types.d.ts → common/types.d.ts} +62 -60
- package/dist/namespaces/podcast/common/types.js.map +1 -0
- package/dist/namespaces/podcast/generate/utils.d.ts +32 -0
- package/dist/namespaces/podcast/generate/utils.js +363 -0
- package/dist/namespaces/podcast/generate/utils.js.map +1 -0
- package/dist/namespaces/podcast/parse/utils.d.ts +31 -0
- package/dist/namespaces/podcast/{utils.js → parse/utils.js} +48 -102
- package/dist/namespaces/podcast/parse/utils.js.map +1 -0
- package/dist/namespaces/slash/{types.d.ts → common/types.d.ts} +1 -1
- package/dist/namespaces/slash/common/types.js.map +1 -0
- package/dist/namespaces/slash/generate/utils.d.ts +3 -0
- package/dist/namespaces/slash/generate/utils.js +14 -0
- package/dist/namespaces/slash/generate/utils.js.map +1 -0
- package/dist/namespaces/slash/parse/utils.d.ts +4 -0
- package/dist/namespaces/slash/parse/utils.js +17 -0
- package/dist/namespaces/slash/parse/utils.js.map +1 -0
- package/dist/namespaces/sy/common/types.d.ts +6 -0
- package/dist/namespaces/sy/common/types.js.map +1 -0
- package/dist/namespaces/sy/generate/utils.d.ts +3 -0
- package/dist/namespaces/sy/generate/utils.js +13 -0
- package/dist/namespaces/sy/generate/utils.js.map +1 -0
- package/dist/namespaces/sy/parse/utils.d.ts +3 -0
- package/dist/namespaces/sy/parse/utils.js +13 -0
- package/dist/namespaces/sy/parse/utils.js.map +1 -0
- package/dist/namespaces/thr/common/types.d.ts +15 -0
- package/dist/namespaces/thr/common/types.js.map +1 -0
- package/dist/namespaces/thr/generate/utils.d.ts +5 -0
- package/dist/namespaces/thr/generate/utils.js +34 -0
- package/dist/namespaces/thr/generate/utils.js.map +1 -0
- package/dist/namespaces/thr/parse/utils.d.ts +5 -0
- package/dist/namespaces/thr/parse/utils.js +34 -0
- package/dist/namespaces/thr/parse/utils.js.map +1 -0
- package/dist/namespaces/wfw/common/types.d.ts +4 -0
- package/dist/namespaces/wfw/common/types.js +2 -0
- package/dist/namespaces/wfw/common/types.js.map +1 -0
- package/dist/namespaces/wfw/generate/utils.d.ts +3 -0
- package/dist/namespaces/wfw/generate/utils.js +12 -0
- package/dist/namespaces/wfw/generate/utils.js.map +1 -0
- package/dist/namespaces/wfw/parse/utils.d.ts +3 -0
- package/dist/namespaces/wfw/parse/utils.js +12 -0
- package/dist/namespaces/wfw/parse/utils.js.map +1 -0
- package/dist/namespaces/yt/common/types.d.ts +8 -0
- package/dist/namespaces/yt/common/types.js +2 -0
- package/dist/namespaces/yt/common/types.js.map +1 -0
- package/dist/namespaces/yt/generate/utils.d.ts +4 -0
- package/dist/namespaces/yt/generate/utils.js +22 -0
- package/dist/namespaces/yt/generate/utils.js.map +1 -0
- package/dist/namespaces/yt/parse/utils.d.ts +4 -0
- package/dist/namespaces/yt/parse/utils.js +22 -0
- package/dist/namespaces/yt/parse/utils.js.map +1 -0
- package/dist/opml/{generate → common}/types.d.ts +12 -11
- package/dist/opml/common/types.js +2 -0
- package/dist/opml/{parse → common}/types.js.map +1 -1
- package/dist/opml/generate/config.js +2 -6
- package/dist/opml/generate/config.js.map +1 -1
- package/dist/opml/generate/index.d.ts +2 -2
- package/dist/opml/generate/index.js +2 -5
- package/dist/opml/generate/index.js.map +1 -1
- package/dist/opml/generate/utils.d.ts +6 -44
- package/dist/opml/generate/utils.js +50 -60
- package/dist/opml/generate/utils.js.map +1 -1
- package/dist/opml/parse/index.d.ts +3 -2
- package/dist/opml/parse/index.js.map +1 -1
- package/dist/opml/parse/utils.d.ts +6 -6
- package/dist/opml/parse/utils.js +26 -26
- package/dist/opml/parse/utils.js.map +1 -1
- package/package.json +10 -7
- package/dist/feeds/atom/parse/types.d.ts +0 -82
- package/dist/feeds/atom/parse/types.js.map +0 -1
- package/dist/feeds/json/generate/types.js.map +0 -1
- package/dist/feeds/json/parse/types.d.ts +0 -49
- package/dist/feeds/rdf/parse/types.d.ts +0 -39
- package/dist/feeds/rdf/parse/types.js.map +0 -1
- package/dist/feeds/rss/parse/types.d.ts +0 -86
- package/dist/namespaces/atom/types.d.ts +0 -1
- package/dist/namespaces/atom/types.js.map +0 -1
- package/dist/namespaces/atom/utils.d.ts +0 -4
- package/dist/namespaces/atom/utils.js +0 -10
- package/dist/namespaces/atom/utils.js.map +0 -1
- package/dist/namespaces/content/types.js.map +0 -1
- package/dist/namespaces/content/utils.d.ts +0 -3
- package/dist/namespaces/content/utils.js +0 -11
- package/dist/namespaces/content/utils.js.map +0 -1
- package/dist/namespaces/dc/types.js.map +0 -1
- package/dist/namespaces/dc/utils.d.ts +0 -3
- package/dist/namespaces/dc/utils.js +0 -25
- package/dist/namespaces/dc/utils.js.map +0 -1
- package/dist/namespaces/itunes/types.js.map +0 -1
- package/dist/namespaces/itunes/utils.d.ts +0 -9
- package/dist/namespaces/itunes/utils.js.map +0 -1
- package/dist/namespaces/media/types.js.map +0 -1
- package/dist/namespaces/media/utils.d.ts +0 -35
- package/dist/namespaces/media/utils.js.map +0 -1
- package/dist/namespaces/podcast/types.js.map +0 -1
- package/dist/namespaces/podcast/utils.d.ts +0 -31
- package/dist/namespaces/podcast/utils.js.map +0 -1
- package/dist/namespaces/slash/types.js.map +0 -1
- package/dist/namespaces/slash/utils.d.ts +0 -4
- package/dist/namespaces/slash/utils.js +0 -23
- package/dist/namespaces/slash/utils.js.map +0 -1
- package/dist/namespaces/sy/types.d.ts +0 -5
- package/dist/namespaces/sy/types.js.map +0 -1
- package/dist/namespaces/sy/utils.d.ts +0 -3
- package/dist/namespaces/sy/utils.js +0 -13
- package/dist/namespaces/sy/utils.js.map +0 -1
- package/dist/opml/generate/types.js.map +0 -1
- package/dist/opml/parse/types.d.ts +0 -38
- /package/dist/feeds/atom/{parse → common}/types.js +0 -0
- /package/dist/feeds/json/{generate → common}/types.js +0 -0
- /package/dist/feeds/{json/parse → rdf/common}/types.js +0 -0
- /package/dist/feeds/{rdf/parse → rss/common}/types.js +0 -0
- /package/dist/{feeds/rss/parse → namespaces/atom/common}/types.js +0 -0
- /package/dist/namespaces/content/{types.d.ts → common/types.d.ts} +0 -0
- /package/dist/namespaces/{atom → content/common}/types.js +0 -0
- /package/dist/namespaces/{content → dc/common}/types.js +0 -0
- /package/dist/namespaces/{dc → dcterms/common}/types.js +0 -0
- /package/dist/namespaces/{itunes → georss/common}/types.js +0 -0
- /package/dist/namespaces/{media → itunes/common}/types.js +0 -0
- /package/dist/namespaces/{podcast → media/common}/types.js +0 -0
- /package/dist/namespaces/{slash → podcast/common}/types.js +0 -0
- /package/dist/namespaces/{sy → slash/common}/types.js +0 -0
- /package/dist/{opml/generate → namespaces/sy/common}/types.js +0 -0
- /package/dist/{opml/parse → namespaces/thr/common}/types.js +0 -0
package/README.md
CHANGED
|
@@ -1,12 +1,21 @@
|
|
|
1
1
|
# Feedsmith
|
|
2
2
|
|
|
3
3
|
[](https://github.com/macieklamberski/feedsmith/actions/workflows/test.yml)
|
|
4
|
+
[](https://codecov.io/gh/macieklamberski/feedsmith)
|
|
4
5
|
[](https://www.npmjs.com/package/feedsmith)
|
|
5
6
|
[](https://github.com/macieklamberski/feedsmith/blob/main/LICENSE)
|
|
6
7
|
|
|
7
|
-
Robust and fast JavaScript parser and generator for RSS, Atom, JSON Feed, and RDF feeds, with support for popular namespaces and OPML files.
|
|
8
|
+
Robust and fast JavaScript parser and generator for RSS, Atom, JSON Feed, and RDF feeds, with support for popular namespaces and OPML files.
|
|
8
9
|
|
|
9
|
-
Feedsmith
|
|
10
|
+
Feedsmith provides both universal and format-specific parsers that maintain the original feed structure in a clean, object-oriented format while intelligently normalizing legacy elements. Access all feed data without compromising simplicity.
|
|
11
|
+
|
|
12
|
+
> [!IMPORTANT]
|
|
13
|
+
>
|
|
14
|
+
> You're viewing the README for the next version of Feedsmith (v2.0), which includes major improvements and breaking changes. While the codebase is stable, the API may still undergo slight changes. This version is currently only available through the `next` channel for early testing. For production use, it is recommended to use the latest stable version.
|
|
15
|
+
> ```bash
|
|
16
|
+
> npm install feedsmith@latest # Stable version 1.9.0
|
|
17
|
+
> npm install feedsmith@next # Development version 2.0.0-next.x
|
|
18
|
+
> ```
|
|
10
19
|
|
|
11
20
|
[Features](#supported-formats)
|
|
12
21
|
·
|
|
@@ -24,13 +33,14 @@ Feedsmith maintains the original feed structure in a clean, object-oriented form
|
|
|
24
33
|
|
|
25
34
|
#### Leniency
|
|
26
35
|
* **Normalizes legacy elements** ✨ — Upgrades feed elements to their modern equivalents so that you never need to worry about reading feeds in older formats.
|
|
27
|
-
* **CaSe INSENsiTive** — Handles fields and attributes in any case (lowercase, uppercase, mixed).
|
|
36
|
+
* **CaSe INSENsiTive** 🐍 — Handles fields and attributes in any case (lowercase, uppercase, mixed).
|
|
37
|
+
* **Smart namespace handling** 🧠 — Automatically normalizes custom namespace prefixes to standard ones (e.g., `<custom:creator>` becomes `dc.creator`).
|
|
28
38
|
|
|
29
39
|
#### Performance and type-safety
|
|
30
|
-
* **Fast parsing** — One of the fastest feed parsers in JavaScript (see [benchmarks](#benchmarks)).
|
|
31
|
-
* **Type-safe API** — TypeScript type definitions are available for each feed format, making it easy to work with the data.
|
|
32
|
-
* **Tree-shakable** — Only include the parts of the library you need, reducing bundle size.
|
|
33
|
-
* **Well-tested** — Comprehensive test suite with
|
|
40
|
+
* **Fast parsing** 🏎️ — One of the fastest feed parsers in JavaScript (see [benchmarks](#benchmarks)).
|
|
41
|
+
* **Type-safe API** 🛟 — TypeScript type definitions are available for each feed format, making it easy to work with the data.
|
|
42
|
+
* **Tree-shakable** 🍃 — Only include the parts of the library you need, reducing bundle size.
|
|
43
|
+
* **Well-tested** 🔬 — Comprehensive test suite with over 2000 tests and 99% code coverage.
|
|
34
44
|
|
|
35
45
|
#### Compatibility
|
|
36
46
|
* Works in Node.js and all modern browsers.
|
|
@@ -49,27 +59,33 @@ Feedsmith maintains the original feed structure in a clean, object-oriented form
|
|
|
49
59
|
|
|
50
60
|
| Format | Versions | Parsing | Generating |
|
|
51
61
|
|--------|----------|---------|------------|
|
|
52
|
-
| [RSS](http://cyber.law.harvard.edu/rss/rss.html) | 0.9x, 2.0 | ✅ |
|
|
53
|
-
| [Atom](https://tools.ietf.org/html/rfc4287) | 0.3, 1.0 | ✅ |
|
|
62
|
+
| [RSS](http://cyber.law.harvard.edu/rss/rss.html) | 0.9x, 2.0 | ✅ | ✅ |
|
|
63
|
+
| [Atom](https://tools.ietf.org/html/rfc4287) | 0.3, 1.0 | ✅ | ✅ |
|
|
54
64
|
| [JSON Feed](https://jsonfeed.org) | 1.0, 1.1 | ✅ | ✅ |
|
|
55
65
|
| [RDF](https://web.resource.org/rss/1.0/spec) | 0.9, 1.0 | ✅ | ⏳ |
|
|
56
66
|
|
|
57
67
|
### Namespaces
|
|
58
68
|
|
|
59
|
-
| Name | Prefix | Supported in | Parsing | Generating |
|
|
60
|
-
|
|
61
|
-
| [Atom](http://www.w3.org/2005/Atom) | `<atom
|
|
62
|
-
| [Dublin Core](http://purl.org/dc/elements/1.1/) | `<dc:*>` | RSS, Atom, RDF | ✅ |
|
|
63
|
-
| [Syndication](http://purl.org/rss/1.0/modules/syndication/) | `<sy:*>` | RSS, Atom, RDF | ✅ |
|
|
64
|
-
| [Content](http://purl.org/rss/1.0/modules/content/) | `<content:*>` | RSS, RDF | ✅ |
|
|
65
|
-
| [Slash](http://purl.org/rss/1.0/modules/slash/) | `<slash:*>` | RSS, Atom, RDF | ✅ |
|
|
66
|
-
| [iTunes](http://www.itunes.com/dtds/podcast-1.0.dtd) | `<itunes:*>` | RSS, Atom | ✅ |
|
|
67
|
-
| [Podcast](https://podcastindex.org/namespace/1.0) | `<podcast:*>` | RSS | ✅ |
|
|
68
|
-
| [Media RSS](http://search.yahoo.com/mrss/) | `<media:*>` | RSS, Atom, RDF | ✅ |
|
|
69
|
-
| [
|
|
70
|
-
| [
|
|
69
|
+
| Name | Prefix[^1] | Supported in | Parsing | Generating |
|
|
70
|
+
|------|---------|--------------|---------|------------|
|
|
71
|
+
| [Atom](http://www.w3.org/2005/Atom) | `<atom:*>` | RSS, RDF | ✅ | ✅ |
|
|
72
|
+
| [Dublin Core](http://purl.org/dc/elements/1.1/) | `<dc:*>` | RSS, Atom, RDF | ✅ | ✅ |
|
|
73
|
+
| [Syndication](http://purl.org/rss/1.0/modules/syndication/) | `<sy:*>` | RSS, Atom, RDF | ✅ | ✅ |
|
|
74
|
+
| [Content](http://purl.org/rss/1.0/modules/content/) | `<content:*>` | RSS, RDF | ✅ | ✅ |
|
|
75
|
+
| [Slash](http://purl.org/rss/1.0/modules/slash/) | `<slash:*>` | RSS, Atom, RDF | ✅ | ✅ |
|
|
76
|
+
| [iTunes](http://www.itunes.com/dtds/podcast-1.0.dtd) | `<itunes:*>` | RSS, Atom | ✅ | ✅ |
|
|
77
|
+
| [Podcast](https://podcastindex.org/namespace/1.0) | `<podcast:*>` | RSS | ✅ | ✅ |
|
|
78
|
+
| [Media RSS](http://search.yahoo.com/mrss/) | `<media:*>` | RSS, Atom, RDF | ✅ | ✅ |
|
|
79
|
+
| [GeoRSS-Simple](http://www.georss.org/georss) | `<georss:*>` | RSS, Atom, RDF | ✅ | ✅ |
|
|
80
|
+
| [Atom Threading](https://www.ietf.org/rfc/rfc4685.txt) | `<thr:*>` | RSS, Atom | ✅ | ✅ |
|
|
81
|
+
| [Dublin Core Terms](http://purl.org/dc/terms/) | `<dcterms:*>` | RSS, Atom, RDF | ✅ | ✅ |
|
|
82
|
+
| [Well-Formed Web](http://wellformedweb.org/CommentAPI/) | `<wfw:*>` | RSS, Atom, RDF | ✅ | ✅ |
|
|
83
|
+
| [YouTube](https://www.youtube.com/feeds/videos.xml) | `<yt:*>` | Atom | ✅ | ✅ |
|
|
71
84
|
| [Administrative](https://web.resource.org/rss/1.0/modules/admin/) | `<admin:*>` | 📋 | 📋 | 📋 |
|
|
72
|
-
| [
|
|
85
|
+
| [GML](http://www.opengis.net/gml) | `<gml:*>` | 📋 | 📋 | 📋 |
|
|
86
|
+
| [GeoRSS GML](http://www.opengis.net/gml) | `<georss:*>` | 📋 | 📋 | 📋 |
|
|
87
|
+
|
|
88
|
+
[^1]: Custom namespace prefixes are automatically normalized to standard ones (e.g., `<custom:creator>` → `dc.creator`).
|
|
73
89
|
|
|
74
90
|
### Other
|
|
75
91
|
|
|
@@ -388,7 +404,7 @@ try {
|
|
|
388
404
|
|
|
389
405
|
### Format detection
|
|
390
406
|
|
|
391
|
-
You can detect feed formats without parsing them.
|
|
407
|
+
You can detect feed formats without parsing them. Detect functions are designed to quickly identify the feed format by looking for its signature, such as the the root tag, version attribute or feed elements.
|
|
392
408
|
|
|
393
409
|
```ts
|
|
394
410
|
import { detectAtomFeed, detectJsonFeed, detectRssFeed, detectRdfFeed } from 'feedsmith'
|
|
@@ -410,9 +426,6 @@ if (detectRdfFeed(content)) {
|
|
|
410
426
|
}
|
|
411
427
|
```
|
|
412
428
|
|
|
413
|
-
> [!WARNING]
|
|
414
|
-
> Detect functions are designed to quickly identify the feed format by looking for its signature, such as the `<rss>` tag in the case of RSS feeds. However, the function may detect an RSS feed even if it is invalid. The feed will be fully validated only when using the `parseRssFeed` function.
|
|
415
|
-
|
|
416
429
|
## Generating
|
|
417
430
|
|
|
418
431
|
### Generating JSON Feed
|
|
@@ -520,45 +533,46 @@ A comprehensive set of benchmarks, categorized by various file sizes, is availab
|
|
|
520
533
|
For a quick overview, here are the results of parsing RSS, Atom, and RDF feeds using various JS packages with Tinybench. Feedsmith's results are marked with an asterisk (`*`).
|
|
521
534
|
|
|
522
535
|
```
|
|
523
|
-
📊 RSS feed parsing (
|
|
524
|
-
|
|
525
|
-
│ │ Package │ Ops/sec │ Average (ms) │ Min (ms) │ Max (ms) │ Runs │
|
|
526
|
-
|
|
527
|
-
│ 0 │ feedsmith * │
|
|
528
|
-
│ 1 │ @
|
|
529
|
-
│ 2 │ @
|
|
530
|
-
│ 3 │
|
|
531
|
-
│ 4 │
|
|
532
|
-
│ 5 │
|
|
533
|
-
│ 6 │
|
|
534
|
-
│ 7 │
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
│
|
|
543
|
-
│
|
|
544
|
-
│
|
|
545
|
-
│
|
|
546
|
-
│
|
|
547
|
-
│
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
│
|
|
556
|
-
│
|
|
557
|
-
│
|
|
558
|
-
│
|
|
559
|
-
│
|
|
560
|
-
│
|
|
561
|
-
|
|
536
|
+
📊 RSS feed parsing (100 files × 100KB–5MB)
|
|
537
|
+
┌───┬───────────────────────────────┬─────────┬──────────────┬──────────┬──────────┬──────┬─────────────┐
|
|
538
|
+
│ │ Package │ Ops/sec │ Average (ms) │ Min (ms) │ Max (ms) │ Runs │ Performance │
|
|
539
|
+
├───┼───────────────────────────────┼─────────┼──────────────┼──────────┼──────────┼──────┼─────────────┤
|
|
540
|
+
│ 0 │ feedsmith * │ 2.15 │ 464.233 │ 431.238 │ 560.196 │ 33 │ baseline │
|
|
541
|
+
│ 1 │ @ulisesgascon/rss-feed-parser │ 1.61 │ 619.751 │ 583.357 │ 702.199 │ 25 │ 1.3x slower │
|
|
542
|
+
│ 2 │ @gaphub/feed │ 1.51 │ 663.333 │ 615.706 │ 753.343 │ 23 │ 1.4x slower │
|
|
543
|
+
│ 3 │ podcast-feed-parser │ 1.40 │ 713.043 │ 663.199 │ 822.646 │ 22 │ 1.5x slower │
|
|
544
|
+
│ 4 │ feedparser │ 0.99 │ 1013.059 │ 943.120 │ 1140.454 │ 15 │ 2.2x slower │
|
|
545
|
+
│ 5 │ @extractus/feed-extractor │ 0.86 │ 1167.174 │ 1105.055 │ 1266.003 │ 13 │ 2.5x slower │
|
|
546
|
+
│ 6 │ feedme.js │ 0.74 │ 1347.627 │ 1192.642 │ 1633.812 │ 12 │ 2.9x slower │
|
|
547
|
+
│ 7 │ rss-parser │ 0.64 │ 1551.783 │ 1495.036 │ 1739.777 │ 10 │ 3.3x slower │
|
|
548
|
+
│ 8 │ @rowanmanning/feed-parser │ 0.46 │ 2186.174 │ 2029.103 │ 2689.577 │ 7 │ 4.7x slower │
|
|
549
|
+
└───┴───────────────────────────────┴─────────┴──────────────┴──────────┴──────────┴──────┴─────────────┘
|
|
550
|
+
|
|
551
|
+
📊 Atom feed parsing (100 files × 100KB–5MB)
|
|
552
|
+
┌───┬───────────────────────────┬─────────┬──────────────┬───────────┬───────────┬──────┬─────────────┐
|
|
553
|
+
│ │ Package │ Ops/sec │ Average (ms) │ Min (ms) │ Max (ms) │ Runs │ Performance │
|
|
554
|
+
├───┼───────────────────────────┼─────────┼──────────────┼───────────┼───────────┼──────┼─────────────┤
|
|
555
|
+
│ 0 │ feedsmith * │ 0.45 │ 2218.248 │ 2195.860 │ 2258.982 │ 7 │ baseline │
|
|
556
|
+
│ 1 │ @rowanmanning/feed-parser │ 0.18 │ 5553.175 │ 5249.846 │ 5861.476 │ 3 │ 2.5x slower │
|
|
557
|
+
│ 2 │ feedparser │ 0.17 │ 6057.445 │ 5563.861 │ 6781.359 │ 3 │ 2.7x slower │
|
|
558
|
+
│ 3 │ @extractus/feed-extractor │ 0.15 │ 6685.829 │ 6494.192 │ 6984.887 │ 3 │ 3.0x slower │
|
|
559
|
+
│ 4 │ @gaphub/feed │ 0.13 │ 7717.126 │ 6402.034 │ 9032.219 │ 2 │ 3.5x slower │
|
|
560
|
+
│ 5 │ feedme.js │ 0.12 │ 8053.625 │ 7935.369 │ 8171.881 │ 2 │ 3.6x slower │
|
|
561
|
+
│ 6 │ rss-parser │ 0.08 │ 12999.252 │ 12819.434 │ 13179.070 │ 2 │ 5.9x slower │
|
|
562
|
+
└───┴───────────────────────────┴─────────┴──────────────┴───────────┴───────────┴──────┴─────────────┘
|
|
563
|
+
|
|
564
|
+
📊 RDF feed parsing (100 files × 100KB–5MB)
|
|
565
|
+
┌───┬───────────────────────────┬─────────┬──────────────┬──────────┬──────────┬──────┬──────────────┐
|
|
566
|
+
│ │ Package │ Ops/sec │ Average (ms) │ Min (ms) │ Max (ms) │ Runs │ Performance │
|
|
567
|
+
├───┼───────────────────────────┼─────────┼──────────────┼──────────┼──────────┼──────┼──────────────┤
|
|
568
|
+
│ 0 │ feedsmith * │ 5.93 │ 168.678 │ 153.476 │ 191.892 │ 89 │ baseline │
|
|
569
|
+
│ 1 │ @rowanmanning/feed-parser │ 3.00 │ 333.512 │ 312.475 │ 387.156 │ 45 │ 2.0x slower │
|
|
570
|
+
│ 2 │ @extractus/feed-extractor │ 1.80 │ 556.240 │ 504.258 │ 621.485 │ 27 │ 3.3x slower │
|
|
571
|
+
│ 3 │ @gaphub/feed │ 1.23 │ 815.776 │ 729.150 │ 1129.571 │ 19 │ 4.8x slower │
|
|
572
|
+
│ 4 │ feedparser │ 0.92 │ 1087.980 │ 1023.638 │ 1128.518 │ 14 │ 6.5x slower │
|
|
573
|
+
│ 5 │ feedme.js │ 0.64 │ 1567.422 │ 1506.713 │ 1626.450 │ 10 │ 9.3x slower │
|
|
574
|
+
│ 6 │ rss-parser │ 0.42 │ 2368.398 │ 2288.041 │ 2438.408 │ 7 │ 14.0x slower │
|
|
575
|
+
└───┴───────────────────────────┴─────────┴──────────────┴──────────┴──────────┴──────┴──────────────┘
|
|
562
576
|
```
|
|
563
577
|
|
|
564
578
|
## FAQ
|
package/dist/common/config.d.ts
CHANGED
|
@@ -1,6 +1,23 @@
|
|
|
1
|
-
import type { X2jOptions } from 'fast-xml-parser';
|
|
1
|
+
import type { X2jOptions, XmlBuilderOptions } from 'fast-xml-parser';
|
|
2
2
|
export declare const parserConfig: X2jOptions;
|
|
3
|
+
export declare const builderConfig: XmlBuilderOptions;
|
|
3
4
|
export declare const locales: {
|
|
4
5
|
unrecognized: string;
|
|
5
6
|
invalid: string;
|
|
6
7
|
};
|
|
8
|
+
export declare const namespaceUrls: {
|
|
9
|
+
atom: string;
|
|
10
|
+
content: string;
|
|
11
|
+
dc: string;
|
|
12
|
+
dcterms: string;
|
|
13
|
+
georss: string;
|
|
14
|
+
itunes: string;
|
|
15
|
+
media: string;
|
|
16
|
+
podcast: string;
|
|
17
|
+
rdf: string;
|
|
18
|
+
slash: string;
|
|
19
|
+
sy: string;
|
|
20
|
+
thr: string;
|
|
21
|
+
wfw: string;
|
|
22
|
+
yt: string;
|
|
23
|
+
};
|
package/dist/common/config.js
CHANGED
|
@@ -12,8 +12,33 @@ export const parserConfig = {
|
|
|
12
12
|
transformTagName: (name) => name.toLowerCase(),
|
|
13
13
|
transformAttributeName: (name) => name.toLowerCase(),
|
|
14
14
|
};
|
|
15
|
+
export const builderConfig = {
|
|
16
|
+
processEntities: true,
|
|
17
|
+
ignoreAttributes: false,
|
|
18
|
+
suppressEmptyNode: true,
|
|
19
|
+
suppressBooleanAttributes: false,
|
|
20
|
+
attributeNamePrefix: '@',
|
|
21
|
+
format: true,
|
|
22
|
+
cdataPropName: '#cdata',
|
|
23
|
+
};
|
|
15
24
|
export const locales = {
|
|
16
25
|
unrecognized: 'Unrecognized feed format',
|
|
17
26
|
invalid: 'Invalid feed format',
|
|
18
27
|
};
|
|
28
|
+
export const namespaceUrls = {
|
|
29
|
+
atom: 'http://www.w3.org/2005/Atom',
|
|
30
|
+
content: 'http://purl.org/rss/1.0/modules/content/',
|
|
31
|
+
dc: 'http://purl.org/dc/elements/1.1/',
|
|
32
|
+
dcterms: 'http://purl.org/dc/terms/',
|
|
33
|
+
georss: 'http://www.georss.org/georss/',
|
|
34
|
+
itunes: 'http://www.itunes.com/dtds/podcast-1.0.dtd',
|
|
35
|
+
media: 'http://search.yahoo.com/mrss/',
|
|
36
|
+
podcast: 'https://podcastindex.org/namespace/1.0',
|
|
37
|
+
rdf: 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
|
|
38
|
+
slash: 'http://purl.org/rss/1.0/modules/slash/',
|
|
39
|
+
sy: 'http://purl.org/rss/1.0/modules/syndication/',
|
|
40
|
+
thr: 'http://purl.org/syndication/thread/1.0',
|
|
41
|
+
wfw: 'http://wellformedweb.org/CommentAPI/',
|
|
42
|
+
yt: 'http://www.youtube.com/xml/schemas/2015',
|
|
43
|
+
};
|
|
19
44
|
//# sourceMappingURL=config.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/common/config.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,YAAY,GAAe;IACtC,UAAU,EAAE,KAAK;IACjB,eAAe,EAAE,KAAK;IACtB,YAAY,EAAE,KAAK;IACnB,aAAa,EAAE,KAAK;IACpB,mBAAmB,EAAE,KAAK;IAC1B,oBAAoB,EAAE,KAAK;IAC3B,gBAAgB,EAAE,KAAK;IACvB,YAAY,EAAE,IAAI;IAClB,iBAAiB,EAAE,IAAI;IACvB,mBAAmB,EAAE,GAAG;IACxB,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE;IAC9C,sBAAsB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE;CACrD,CAAA;AAED,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,YAAY,EAAE,0BAA0B;IACxC,OAAO,EAAE,qBAAqB;CAC/B,CAAA"}
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/common/config.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,YAAY,GAAe;IACtC,UAAU,EAAE,KAAK;IACjB,eAAe,EAAE,KAAK;IACtB,YAAY,EAAE,KAAK;IACnB,aAAa,EAAE,KAAK;IACpB,mBAAmB,EAAE,KAAK;IAC1B,oBAAoB,EAAE,KAAK;IAC3B,gBAAgB,EAAE,KAAK;IACvB,YAAY,EAAE,IAAI;IAClB,iBAAiB,EAAE,IAAI;IACvB,mBAAmB,EAAE,GAAG;IACxB,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE;IAC9C,sBAAsB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE;CACrD,CAAA;AAED,MAAM,CAAC,MAAM,aAAa,GAAsB;IAC9C,eAAe,EAAE,IAAI;IACrB,gBAAgB,EAAE,KAAK;IACvB,iBAAiB,EAAE,IAAI;IACvB,yBAAyB,EAAE,KAAK;IAChC,mBAAmB,EAAE,GAAG;IACxB,MAAM,EAAE,IAAI;IACZ,aAAa,EAAE,QAAQ;CACxB,CAAA;AAED,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,YAAY,EAAE,0BAA0B;IACxC,OAAO,EAAE,qBAAqB;CAC/B,CAAA;AAED,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,6BAA6B;IACnC,OAAO,EAAE,0CAA0C;IACnD,EAAE,EAAE,kCAAkC;IACtC,OAAO,EAAE,2BAA2B;IACpC,MAAM,EAAE,+BAA+B;IACvC,MAAM,EAAE,4CAA4C;IACpD,KAAK,EAAE,+BAA+B;IACtC,OAAO,EAAE,wCAAwC;IACjD,GAAG,EAAE,6CAA6C;IAClD,KAAK,EAAE,wCAAwC;IAC/C,EAAE,EAAE,8CAA8C;IAClD,GAAG,EAAE,wCAAwC;IAC7C,GAAG,EAAE,sCAAsC;IAC3C,EAAE,EAAE,yCAAyC;CAC9C,CAAA"}
|
package/dist/common/parse.d.ts
CHANGED
|
@@ -1,18 +1,19 @@
|
|
|
1
|
-
import type { Feed as AtomFeed } from '../feeds/atom/
|
|
2
|
-
import type { Feed as JsonFeed } from '../feeds/json/
|
|
3
|
-
import type { Feed as RdfFeed } from '../feeds/rdf/
|
|
4
|
-
import type { Feed as RssFeed } from '../feeds/rss/
|
|
1
|
+
import type { Feed as AtomFeed } from '../feeds/atom/common/types.js';
|
|
2
|
+
import type { Feed as JsonFeed } from '../feeds/json/common/types.js';
|
|
3
|
+
import type { Feed as RdfFeed } from '../feeds/rdf/common/types.js';
|
|
4
|
+
import type { Feed as RssFeed } from '../feeds/rss/common/types.js';
|
|
5
|
+
import type { DeepPartial } from './types.js';
|
|
5
6
|
export type Feed = {
|
|
6
7
|
type: 'json';
|
|
7
|
-
feed: JsonFeed
|
|
8
|
+
feed: DeepPartial<JsonFeed<string>>;
|
|
8
9
|
} | {
|
|
9
10
|
type: 'rss';
|
|
10
|
-
feed: RssFeed
|
|
11
|
+
feed: DeepPartial<RssFeed<string>>;
|
|
11
12
|
} | {
|
|
12
13
|
type: 'atom';
|
|
13
|
-
feed: AtomFeed
|
|
14
|
+
feed: DeepPartial<AtomFeed<string>>;
|
|
14
15
|
} | {
|
|
15
16
|
type: 'rdf';
|
|
16
|
-
feed: RdfFeed
|
|
17
|
+
feed: DeepPartial<RdfFeed<string>>;
|
|
17
18
|
};
|
|
18
19
|
export declare const parse: (value: unknown) => Feed;
|
package/dist/common/parse.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"parse.js","sourceRoot":"","sources":["../../src/common/parse.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"parse.js","sourceRoot":"","sources":["../../src/common/parse.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,IAAI,cAAc,EAAE,MAAM,+BAA+B,CAAA;AACxE,OAAO,EAAE,KAAK,IAAI,aAAa,EAAE,MAAM,8BAA8B,CAAA;AAErE,OAAO,EAAE,MAAM,IAAI,cAAc,EAAE,MAAM,+BAA+B,CAAA;AACxE,OAAO,EAAE,KAAK,IAAI,aAAa,EAAE,MAAM,8BAA8B,CAAA;AAErE,OAAO,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,8BAA8B,CAAA;AACtE,OAAO,EAAE,KAAK,IAAI,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAEnE,OAAO,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,8BAA8B,CAAA;AACtE,OAAO,EAAE,KAAK,IAAI,YAAY,EAAE,MAAM,6BAA6B,CAAA;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AASrC,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,KAAc,EAAQ,EAAE;IAC5C,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,CAAA;IACrD,CAAC;IAED,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,CAAA;IACrD,CAAC;IAED,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,CAAA;IACnD,CAAC;IAED,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,CAAA;IACnD,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;AACvC,CAAC,CAAA"}
|
package/dist/common/types.d.ts
CHANGED
|
@@ -1,2 +1,15 @@
|
|
|
1
1
|
export type Unreliable = any;
|
|
2
|
-
export type
|
|
2
|
+
export type DateLike = Date | string;
|
|
3
|
+
export type AnyOf<T> = Partial<{
|
|
4
|
+
[P in keyof T]-?: NonNullable<T[P]>;
|
|
5
|
+
}> & {
|
|
6
|
+
[P in keyof T]-?: Pick<{
|
|
7
|
+
[Q in keyof T]-?: NonNullable<T[Q]>;
|
|
8
|
+
}, P>;
|
|
9
|
+
}[keyof T];
|
|
10
|
+
export type DeepPartial<T> = T extends Array<infer U> ? Array<DeepPartial<U>> : T extends (...args: unknown[]) => unknown ? T : T extends object ? T extends null ? T : {
|
|
11
|
+
[P in keyof T]?: DeepPartial<T[P]>;
|
|
12
|
+
} : T;
|
|
13
|
+
export type ParseExactFunction<R> = (value: Unreliable) => R | undefined;
|
|
14
|
+
export type ParsePartialFunction<R> = (value: Unreliable) => DeepPartial<R> | undefined;
|
|
15
|
+
export type GenerateFunction<V> = (value: V | undefined) => Unreliable | undefined;
|
package/dist/common/utils.d.ts
CHANGED
|
@@ -1,22 +1,34 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { XMLBuilder } from 'fast-xml-parser';
|
|
2
|
+
import type { AnyOf, GenerateFunction, ParseExactFunction, Unreliable } from './types.js';
|
|
2
3
|
export declare const isPresent: <T>(value: T) => value is NonNullable<T>;
|
|
3
4
|
export declare const isObject: (value: Unreliable) => value is Record<string, Unreliable>;
|
|
5
|
+
export declare const isNonEmptyString: (value: Unreliable) => value is string;
|
|
4
6
|
export declare const isNonEmptyStringOrNumber: (value: Unreliable) => value is string | number;
|
|
5
7
|
export declare const retrieveText: (value: Unreliable) => Unreliable;
|
|
6
|
-
export declare const trimObject: <T extends Record<string, unknown>>(object: T) =>
|
|
7
|
-
export declare const trimArray: <T, R = T>(value: Array<T
|
|
8
|
+
export declare const trimObject: <T extends Record<string, unknown>>(object: T) => AnyOf<T> | undefined;
|
|
9
|
+
export declare const trimArray: <T, R = T>(value: Array<T> | undefined, parse?: ParseExactFunction<R>) => Array<R> | undefined;
|
|
8
10
|
export declare const stripCdata: (text: Unreliable) => any;
|
|
9
11
|
export declare const hasEntities: (text: string) => boolean;
|
|
10
|
-
export declare const parseString:
|
|
11
|
-
export declare const parseNumber:
|
|
12
|
-
export declare const parseBoolean:
|
|
13
|
-
export declare const parseYesNoBoolean:
|
|
14
|
-
export declare const
|
|
15
|
-
export declare const
|
|
12
|
+
export declare const parseString: ParseExactFunction<string>;
|
|
13
|
+
export declare const parseNumber: ParseExactFunction<number>;
|
|
14
|
+
export declare const parseBoolean: ParseExactFunction<boolean>;
|
|
15
|
+
export declare const parseYesNoBoolean: ParseExactFunction<boolean>;
|
|
16
|
+
export declare const parseDate: ParseExactFunction<string>;
|
|
17
|
+
export declare const parseArray: ParseExactFunction<Array<Unreliable>>;
|
|
18
|
+
export declare const parseArrayOf: <R>(value: Unreliable, parse: ParseExactFunction<R>) => Array<R> | undefined;
|
|
16
19
|
export declare const parseSingular: <T>(value: T | Array<T>) => T;
|
|
17
|
-
export declare const parseSingularOf: <R>(value: Unreliable, parse:
|
|
18
|
-
export declare const parseCsvOf: <T>(value: Unreliable, parse:
|
|
19
|
-
export declare const
|
|
20
|
-
export declare const
|
|
21
|
-
export declare const
|
|
22
|
-
export declare const
|
|
20
|
+
export declare const parseSingularOf: <R>(value: Unreliable, parse: ParseExactFunction<R>) => R | undefined;
|
|
21
|
+
export declare const parseCsvOf: <T>(value: Unreliable, parse: ParseExactFunction<T>) => Array<T> | undefined;
|
|
22
|
+
export declare const generateCsvOf: <T>(value: Array<T> | undefined, generate?: GenerateFunction<T>) => string | undefined;
|
|
23
|
+
export declare const generateXml: (builder: XMLBuilder, value: string) => string;
|
|
24
|
+
export declare const generateRfc822Date: GenerateFunction<string | Date>;
|
|
25
|
+
export declare const generateRfc3339Date: GenerateFunction<string | Date>;
|
|
26
|
+
export declare const generateBoolean: GenerateFunction<boolean>;
|
|
27
|
+
export declare const generateYesNoBoolean: GenerateFunction<boolean>;
|
|
28
|
+
export declare const detectNamespaces: (value: unknown, recursive?: boolean) => Set<string>;
|
|
29
|
+
export declare const generateCdataString: GenerateFunction<string>;
|
|
30
|
+
export declare const generatePlainString: GenerateFunction<string>;
|
|
31
|
+
export declare const generateNumber: GenerateFunction<number>;
|
|
32
|
+
export declare const generateNamespaceAttrs: (value: Unreliable, namespaceUrls: Record<string, string>) => Record<string, string> | undefined;
|
|
33
|
+
export declare const invertObject: (object: Record<string, string>) => Record<string, string>;
|
|
34
|
+
export declare const createNamespaceNormalizator: (namespaceUrls: Record<string, string>, primaryNamespace?: string) => (object: Unreliable) => Unreliable;
|