This documentation is also published as Markdown for efficient machine reading: the whole site is indexed at /llms.txt, and every page has a clean Markdown copy under /_llms/. These are generated from the same source and cost far fewer tokens to read than this rendered HTML.

Skip to main content Skip to navigation

IHasSearchFacets Pennington.Search

Capability interface for an IFrontMatter type that declares custom search facet axes beyond the built-in section/tag/area dimensions. Each entry becomes a facet dimension on the page's search records, so the client can filter on it.

Properties

SearchFacets IReadOnlyDictionary<string, string[]>
Custom facet axes for this page: each key is a facet dimension (for example "company" or "language"), each value the page's membership values within that dimension. Return an empty dictionary to contribute none.

Pennington.Search.IHasSearchFacets

namespace Pennington.Search;

/// Capability interface for an IFrontMatter type that declares custom search facet axes beyond the built-in section/tag/area dimensions. Each entry becomes a facet dimension on the page's search records, so the client can filter on it.
public interface IHasSearchFacets
{
    /// Custom facet axes for this page: each key is a facet dimension (for example "company" or "language"), each value the page's membership values within that dimension. Return an empty dictionary to contribute none.
    
public IReadOnlyDictionary<string, string[]> SearchFacets { get; }
}