88[ ![ Backers] [ backers-badge ]] [ collective ]
99[ ![ Chat] [ chat-badge ]] [ chat ]
1010
11- [ xast] [ ] utility to build (web) feeds ([ RSS] [ rss-spec ] , [ Atom] [ atom-spec ] ).
11+ [ xast] [ ] utility to build (web) feeds ([ RSS] [ ] , [ Atom] [ ] ).
1212
1313## Contents
1414
@@ -54,7 +54,7 @@ Just using either RSS or Atom is probably fine: no need to do both.
5454## Install
5555
5656This package is [ ESM only] [ esm ] .
57- In Node.js (version 14.14+ and 16.0 +), install with [ npm] [ ] :
57+ In Node.js (version 16 +), install with [ npm] [ ] :
5858
5959``` sh
6060npm install xast-util-feed
@@ -167,18 +167,18 @@ Yields (pretty printed):
167167
168168## API
169169
170- This package exports the identifiers [ ` atom ` ] [ atom ] and [ ` rss ` ] [ rss ] .
170+ This package exports the identifiers [ ` atom ` ] [ api- atom] and [ ` rss ` ] [ api- rss] .
171171There is no default export.
172172
173173### ` atom(channel, data) `
174174
175- Build an [ Atom] [ atom-spec ] feed.
175+ Build an [ Atom] [ ] feed.
176176
177177###### Parameters
178178
179- * ` channel ` ([ ` Channel ` ] [ channel ] )
179+ * ` channel ` ([ ` Channel ` ] [ api- channel] )
180180 — data on the feed (the group of items)
181- * ` data ` ([ ` Array<Entry> ` ] [ entry ] , optional)
181+ * ` data ` ([ ` Array<Entry> ` ] [ api- entry] , optional)
182182 — list of entries
183183
184184###### Returns
@@ -187,13 +187,13 @@ Atom feed ([`Root`][root]).
187187
188188### ` rss(channel, data) `
189189
190- Build an [ RSS] [ rss-spec ] feed.
190+ Build an [ RSS] [ ] feed.
191191
192192###### Parameters
193193
194- * ` channel ` ([ ` Channel ` ] [ channel ] )
194+ * ` channel ` ([ ` Channel ` ] [ api- channel] )
195195 — data on the feed (the group of items)
196- * ` data ` ([ ` Array<Entry> ` ] [ entry ] , optional)
196+ * ` data ` ([ ` Array<Entry> ` ] [ api- entry] , optional)
197197 — list of entries
198198
199199###### Returns
@@ -259,7 +259,7 @@ You *should* define this.
259259
260260###### ` author `
261261
262- Optional author of the whole channel (` string ` or [ ` Author ` ] [ author ] ).
262+ Optional author of the whole channel (` string ` or [ ` Author ` ] [ api- author] ).
263263
264264Either ` string ` , in which case it’s as passing ` {name: string} ` .
265265Or an author object.
@@ -348,20 +348,25 @@ Categories of the entry (`Array<string>?`, example: `['laravel',
348348
349349###### ` enclosure `
350350
351- Attached media ([ ` Enclosure? ` ] [ enclosure ] ).
351+ Attached media ([ ` Enclosure? ` ] [ api- enclosure] ).
352352
353353## Types
354354
355355This package is fully typed with [ TypeScript] [ ] .
356- It exports the additional types [ ` Author ` ] [ author ] , [ ` Channel ` ] [ channel ] ,
357- [ ` Enclosure ` ] [ enclosure ] , and [ ` Entry ` ] [ entry ] .
356+ It exports the additional types [ ` Author ` ] [ api-author ] ,
357+ [ ` Channel ` ] [ api-channel ] ,
358+ [ ` Enclosure ` ] [ api-enclosure ] , and
359+ [ ` Entry ` ] [ api-entry ] .
358360
359361## Compatibility
360362
361- Projects maintained by the unified collective are compatible with all maintained
363+ Projects maintained by the unified collective are compatible with maintained
362364versions of Node.js.
363- As of now, that is Node.js 14.14+ and 16.0+.
364- Our projects sometimes work with older versions, but this is not guaranteed.
365+
366+ When we cut a new major release, we drop support for unmaintained versions of
367+ Node.
368+ This means we try to keep the current release line, ` xast-util-feed@^1 ` ,
369+ compatible with Node.js 12.
365370
366371## Security
367372
@@ -404,9 +409,9 @@ abide by its terms.
404409
405410[ downloads ] : https://www.npmjs.com/package/xast-util-feed
406411
407- [ size-badge ] : https://img.shields.io/bundlephobia/minzip/ xast-util-feed.svg
412+ [ size-badge ] : https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q= xast-util-feed
408413
409- [ size ] : https://bundlephobia .com/result?p =xast-util-feed
414+ [ size ] : https://bundlejs .com/?q =xast-util-feed
410415
411416[ sponsors-badge ] : https://opencollective.com/unified/sponsors/badge.svg
412417
@@ -442,20 +447,20 @@ abide by its terms.
442447
443448[ root ] : https://github.com/syntax-tree/xast#root
444449
445- [ rss-spec ] : https://www.rssboard.org/rss-specification
450+ [ rss ] : https://www.rssboard.org/rss-specification
446451
447- [ atom-spec ] : https://tools.ietf.org/html/rfc4287
452+ [ atom ] : https://tools.ietf.org/html/rfc4287
448453
449454[ bcp47 ] : https://github.com/wooorm/bcp-47
450455
451- [ atom ] : #atomchannel-data
456+ [ api- atom] : #atomchannel-data
452457
453- [ rss ] : #rsschannel-data
458+ [ api- rss] : #rsschannel-data
454459
455- [ author ] : #author
460+ [ api- author] : #author
456461
457- [ channel ] : #channel
462+ [ api- channel] : #channel
458463
459- [ enclosure ] : #enclosure
464+ [ api- enclosure] : #enclosure
460465
461- [ entry ] : #entry
466+ [ api- entry] : #entry
0 commit comments