Home / Type/ GlobOptions Type — astro Architecture

GlobOptions Type — astro Architecture

Architecture documentation for the GlobOptions type/interface in glob.ts from the astro codebase.

Entity Profile

Dependency Diagram

graph TD
  86a419c9_3d83_6f8f_83d9_ccb42c656966["GlobOptions"]
  6e7c310e_d293_0d26_5ed9_d09724209fd3["glob.ts"]
  86a419c9_3d83_6f8f_83d9_ccb42c656966 -->|defined in| 6e7c310e_d293_0d26_5ed9_d09724209fd3
  style 86a419c9_3d83_6f8f_83d9_ccb42c656966 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro/src/content/loaders/glob.ts lines 23–39

interface GlobOptions {
	/** The glob pattern to match files, relative to the base directory */
	pattern: string | Array<string>;
	/** The base directory to resolve the glob pattern from. Relative to the root directory, or an absolute file URL. Defaults to `.` */
	base?: string | URL;
	/**
	 * Function that generates an ID for an entry. Default implementation generates a slug from the entry path.
	 * @returns The ID of the entry. Must be unique per collection.
	 **/
	generateId?: (options: GenerateIdOptions) => string;
	/**
	 * Retains the unparsed body of the file in the data store, in addition to the rendered HTML.
	 * If `false`, `entry.body` will be undefined if the content type has a parser.
	 * Defaults to `true`.
	 */
	retainBody?: boolean;
}

Frequently Asked Questions

What is the GlobOptions type?
GlobOptions is a type/interface in the astro codebase, defined in packages/astro/src/content/loaders/glob.ts.
Where is GlobOptions defined?
GlobOptions is defined in packages/astro/src/content/loaders/glob.ts at line 23.

Analyze Your Own Codebase

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

Try Supermodel Free