buildSearchIndex

buildSearchIndex<T>(workspace, options): Promise<{ data: T; engine: string; }>

Defined in: standalone.ts:43

Build search index from a Workspace AST

This is the main entry point - a pure function that takes a Workspace and returns a search index.

Type Parameters

T

T = RawIndexData

Parameters

workspace

SpeculatorASTSchema

options

BuildSearchIndexOptions = {}

Returns

Promise<{ data: T; engine: string; }>

Example

import { SpeculatorPipeline, corePlugins } from '@openuji/speculator';
import { buildSearchIndex } from '@openuji/speculator-search';

const pipeline = new SpeculatorPipeline(corePlugins);
const result = await pipeline.runWorkspace({ entries, fileProvider });

const { data } = await buildSearchIndex(result.workspace);
// data.documents contains search entries