Glossary

Glossary

Domain and project terms used throughout @canvasflow/feed and this wiki.

← Back to Home

Term	Meaning
Canvasflow	The platform whose component model this library targets.
Component	A single content block in the output (headline, image, gallery, video, custom, …). See Component Types.
ComponentType / TextType	The string-literal unions of all component kinds / all text kinds (text1–text60 included).
RSSFeed	The class that parses, validates, and builds a feed. See RSS Feeds.
HTMLMapper	The class that converts an HTML string into Component[]. See HTML Mapping.
validate()	Checks required tags against the Tag.ts allow-lists and fills errors/warnings.
build()	Produces the typed RSS, converting each item's content:encoded into components.
content:encoded	The Content-namespace element holding an item's full HTML body — the source of components.
Mapping	A rule (match + filters, plus a component for component mappings) telling the engine how to recognise an element. See Custom Mappings.
Params	The configuration object (mappings, excludes, ignoreParagraphWrap) passed to RSSFeed/HTMLMapper.
Filter	A tag, class, or attribute matcher inside a mapping. The attribute filter has an exact-value and a regex pattern form.
match	How many of a mapping's filters must match: any or all (class filters also allow equal).
Excludes	Base mappings whose matches (and children) are removed before conversion; also data-cf-ignore.
Node	A himalaya AST node (element / text / comment). Helpers live in node/Node.ts.
himalaya	The HTML-to-JSON parser used to build the AST that the engine reduces.
fast-xml-parser	The XML parser behind RSSFeed; exposes attributes with the @_ prefix.
sanitize-html	Sanitizes serialized nodes to an allowed tag/attribute set when building components.
cf: namespace	Canvasflow RSS extensions (cf:isSponsored, cf:isPaid, cf:thumbnail, …).
Recipe	A JSON-LD recipe extracted from a page by RSSFeed.getRecipeFromUrl; schema in schema/Schema.ts.
Vite+ / vp	The unified toolchain (@voidzero-dev/vite-plus-*) for build, test, lint, and format.
GitHub Packages	The registry the package is published to, under the @canvasflow scope.

See also

• Architecture
• API Reference
• HTML Mapping · Custom Mappings · RSS Feeds