astro/dist/content/loaders/file.d.ts

Astro is a modern site builder with web best practices, performance, and DX front-of-mind.

import type { Loader } from './types.js';
export interface FileOptions {
    /**
     * the parsing function to use for this data
     * @default JSON.parse or yaml.load, depending on the extension of the file
     * */
    parser?: (text: string) => Record<string, Record<string, unknown>> | Array<Record<string, unknown>>;
}
/**
 * Loads entries from a JSON file. The file must contain an array of objects that contain unique `id` fields, or an object with string keys.
 * @param fileName The path to the JSON file to load, relative to the content directory.
 * @param options Additional options for the file loader
 */
export declare function file(fileName: string, options?: FileOptions): Loader;