docs/content/docs/4.utils/4.query-collection-search-sections.md (1)

26-26: Type signature in documentation is incomplete.

The function signature in the Type section doesn't include extraFields in the options, but the API section below documents it. Update the type signature for consistency:

📝 Suggested fix

-function queryCollectionSearchSections(collection: keyof Collections, opts?: { ignoredTags?: string[], minHeading?: string, maxHeading?: string }): ChainablePromise<T, Section[]>
+function queryCollectionSearchSections(collection: keyof Collections, opts?: { ignoredTags?: string[], minHeading?: string, maxHeading?: string, extraFields?: string[] }): ChainablePromise<T, Section[]>

src/runtime/internal/search.ts (1)

30-40: Pipeline failure: Type error when spreading extraFields into select().

The widened type (string | symbol | number)[] for extraFields causes a TypeScript error at line 37 because select() expects keyof T. Since you're already casting extraFields as string[] at line 40, apply a similar cast when passing to select():

🔧 Proposed fix

   const documents = await queryBuilder
     .where('extension', '=', 'md')
-    .select('path', 'body', 'description', 'title', ...(extraFields || []))
+    .select('path', 'body', 'description', 'title', ...((extraFields || []) as string[]))
     .all()

docs/content/docs/4.utils/4.query-collection-search-sections.md (1)

48-55: Clarify that extraFields extends the section object properties.

The documentation for the return value (lines 49-55) lists the standard properties (id, title, titles, content, level) but doesn't mention that when extraFields is provided, those additional fields will also be present in each section object.

Consider adding a note like:

  - `extraFields`: An array of additional fields from the collection items to include in the section objects.
- Returns: A Promise that resolves to an array of searchable sections. Each section is an object with the following properties:
  - `id`: A unique identifier for the section.
  - `title`: The title of the section (usually the heading text).
  - `titles`: An array of parent section titles, representing the hierarchy.
  - `content`: The textual content of the section.
  - `level`: The heading level (1-6) of the section, where 1 is the highest level.
  - Any additional fields specified in the `extraFields` option will also be included in each section.

This helps users understand that the section objects are dynamically extended based on the extraFields option.