IndexEngine
Defined in: engines/index.ts:35
Index Engine Interface
Implement this to create custom search index formats.
Type Parameters
Section titled “Type Parameters”T = unknown
Properties
Section titled “Properties”
readonlyname:string
Defined in: engines/index.ts:37
Unique engine identifier
Methods
Section titled “Methods”addDocument()
Section titled “addDocument()”addDocument(
entries,context):void|Promise<void>
Defined in: engines/index.ts:47
Add entries from a document to the index
Parameters
Section titled “Parameters”entries
Section titled “entries”context
Section titled “context”Returns
Section titled “Returns”void | Promise<void>
finalize()
Section titled “finalize()”finalize():
IndexEngineResult<T> |Promise<IndexEngineResult<T>>
Defined in: engines/index.ts:55
Finalize and return the index data
Returns
Section titled “Returns”IndexEngineResult<T> | Promise<IndexEngineResult<T>>
init()?
Section titled “init()?”
optionalinit():void|Promise<void>
Defined in: engines/index.ts:42
Initialize the engine (called once before indexing)
Returns
Section titled “Returns”void | Promise<void>