LoaderContext Type — astro Architecture

Source Code

packages/astro/src/content/loaders/types.ts lines 29–55

export interface LoaderContext {
	/** The unique name of the collection */
	collection: string;
	/** A database to store the actual data */
	store: DataStore;
	/**  A simple KV store, designed for things like sync tokens */
	meta: MetaStore;
	logger: AstroIntegrationLogger;
	/** Astro config, with user config and merged defaults */
	config: AstroConfig;
	/** Validates and parses the data according to the collection schema */
	parseData<TData extends Record<string, unknown>>(props: ParseDataOptions<TData>): Promise<TData>;

	/** Renders markdown content to HTML and metadata */
	renderMarkdown(content: string, options?: RenderMarkdownOptions): Promise<RenderedContent>;

	/** Generates a non-cryptographic content digest. This can be used to check if the data has changed */
	generateDigest(data: Record<string, unknown> | string): string;

	/** When running in dev, this is a filesystem watcher that can be used to trigger updates */
	watcher?: FSWatcher;

	/** If the loader has been triggered by an integration, this may optionally contain extra data set by that integration */
	refreshContextData?: Record<string, unknown>;
	/** @internal */
	entryTypes: Map<string, ContentEntryType>;
}