Home / Type/ RSSOptions Type — astro Architecture

RSSOptions Type — astro Architecture

Architecture documentation for the RSSOptions type/interface in index.ts from the astro codebase.

Entity Profile

Dependency Diagram

graph TD
  bc270148_2a3b_d9da_a715_1eeb922e13ff["RSSOptions"]
  6ef7bfdb_4b52_2205_aa0f_e41748222587["index.ts"]
  bc270148_2a3b_d9da_a715_1eeb922e13ff -->|defined in| 6ef7bfdb_4b52_2205_aa0f_e41748222587
  style bc270148_2a3b_d9da_a715_1eeb922e13ff fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro-rss/src/index.ts lines 9–31

export type RSSOptions = {
	/** Title of the RSS Feed */
	title: z.infer<typeof rssOptionsValidator>['title'];
	/** Description of the RSS Feed */
	description: z.infer<typeof rssOptionsValidator>['description'];
	/**
	 * Specify the base URL to use for RSS feed links.
	 * We recommend using the [endpoint context object](https://docs.astro.build/en/reference/api-reference/#site),
	 * which includes the `site` configured in your project's `astro.config.*`
	 */
	site: z.infer<typeof rssOptionsValidator>['site'] | URL;
	/** List of RSS feed items to render. */
	items: RSSFeedItem[] | GlobResult;
	/** Specify arbitrary metadata on opening <xml> tag */
	xmlns?: z.infer<typeof rssOptionsValidator>['xmlns'];
	/**
	 * Specifies a local custom XSL stylesheet. Ex. '/public/custom-feed.xsl'
	 */
	stylesheet?: z.infer<typeof rssOptionsValidator>['stylesheet'];
	/** Specify custom data in opening of file */
	customData?: z.infer<typeof rssOptionsValidator>['customData'];
	trailingSlash?: z.infer<typeof rssOptionsValidator>['trailingSlash'];
};

Frequently Asked Questions

What is the RSSOptions type?
RSSOptions is a type/interface in the astro codebase, defined in packages/astro-rss/src/index.ts.
Where is RSSOptions defined?
RSSOptions is defined in packages/astro-rss/src/index.ts at line 9.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free