docs: add search to workflows reference (#11054)

* docs: add search to workflows reference

* fix error
This commit is contained in:
Shahed Nasser
2025-01-20 17:02:29 +02:00
committed by GitHub
parent 5b9cb5a2be
commit af350c3a8b
15 changed files with 349 additions and 112 deletions
@@ -0,0 +1,32 @@
import MiniSearch, { Options as MiniSearchOptions } from "minisearch"
type BaseSearchRecord = Record<string, unknown>
type GetLocalSearchInput<T extends BaseSearchRecord = BaseSearchRecord> = {
docs: T[]
searchableFields: string[]
options?: Omit<MiniSearchOptions, "fields">
}
type SearchResult<T> = (T & {
terms?: string[]
})[]
export type LocalSearch<T extends BaseSearchRecord = BaseSearchRecord> =
MiniSearch & {
search: (query: string) => SearchResult<T>
}
export const getLocalSearch = <T extends BaseSearchRecord = BaseSearchRecord>({
docs,
searchableFields,
options,
}: GetLocalSearchInput<T>): LocalSearch<T> => {
const miniSearch = new MiniSearch({
fields: searchableFields,
...options,
})
miniSearch.addAll(docs)
return miniSearch as LocalSearch<T>
}
+1
View File
@@ -4,6 +4,7 @@ export * from "./check-sidebar-item-visibility"
export * from "./decode-str"
export * from "./dom-utils"
export * from "./get-link-with-base-path"
export * from "./get-local-search"
export * from "./get-navbar-items"
export * from "./os-browser-utils"
export * from "./get-scrolled-top"