From 55e88e6ebf640592ff18bff73d0aa50c67f427d2 Mon Sep 17 00:00:00 2001 From: Marc Cataford Date: Sun, 18 Feb 2024 04:03:04 -0500 Subject: [PATCH] docs: add general details to proxy documentation --- netlify/functions/rss-proxy/rss-proxy.ts | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/netlify/functions/rss-proxy/rss-proxy.ts b/netlify/functions/rss-proxy/rss-proxy.ts index 4eb78ba..008b819 100755 --- a/netlify/functions/rss-proxy/rss-proxy.ts +++ b/netlify/functions/rss-proxy/rss-proxy.ts @@ -1,3 +1,15 @@ +/* + * Fetches and parses RSS feeds. + * + * This handles the fetching, XML parsing and formatting of + * RSS feed data so that the frontent clients do not have to. + * + * This is operating on a "by-feed" basis such that each + * run only processes one feed, and the clients are expected + * to make multiple requests if they have a list of feeds to + * follow. + */ + import axios from 'axios' import { parseFeed } from 'htmlparser2'