polen/build/api/content/scan.d.ts

A framework for delightful GraphQL developer portals

import { FileRouter } from '#lib/file-router/index';
import { Tree } from '@wollybeard/kit';
import type { Page } from './page.js';
export interface ScanResult {
    list: Page[];
    tree: Tree.Tree<Page>;
    diagnostics: FileRouter.Diagnostic[];
}
/**
 * Scan a directory for pages and extract metadata from their front matter
 * By default, hidden pages are filtered out from both the pages list and route tree.
 */
export declare const scan: (options: {
    dir: string;
    glob?: string;
    /** Include hidden pages in the result (useful for debugging or admin interfaces) */
    includeHidden?: boolean;
}) => Promise<ScanResult>;
//# sourceMappingURL=scan.d.ts.map