@ng-doc/app/interfaces/search-result.d.ts

<!-- PROJECT LOGO --> <br /> <div align="center"> <a href="https://github.com/ng-doc/ng-doc"> <img src="https://ng-doc.com/assets/images/ng-doc.svg?raw=true" alt="Logo" height="150px"> </a>

import { NgDocPageIndex } from '@ng-doc/core/interfaces';
import { NgDocHighlightPosition } from '@ng-doc/ui-kit';
/**
 * Results of a search query.
 */
export interface NgDocSearchResult {
    /**
     * Index that was found.
     */
    index: NgDocPageIndex;
    /**
     * Positions of the found terms.
     */
    positions: Partial<Record<keyof NgDocPageIndex, NgDocHighlightPosition[]>>;
}