Search
Preparing search index...
The search index is not available
TypeDoc Pages Plugin
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Home
Search
SearchIndexBuilder
Class SearchIndexBuilder
Hierarchy
SearchIndexBuilder
Implements
SearchManager
Index
Constructors
constructor
Properties
_index
Data
Manager
_options
Methods
_build
Index
_get
Type
Doc
Index
_write
Index
File
populate
Search
Index
Constructors
constructor
new
Search
Index
Builder
(
options
:
PluginOptions
, indexDataManager
:
IndexDataManager
)
:
SearchIndexBuilder
Creates an instance of SearchManager
Parameters
options:
PluginOptions
Plugin options
indexDataManager:
IndexDataManager
Index data manager
Returns
SearchIndexBuilder
Properties
Private
_index
Data
Manager
_index
Data
Manager
:
IndexDataManager
Private
_options
_options
:
PluginOptions
Methods
Private
_build
Index
_build
Index
(
index
:
IndexData
)
:
any
Parameters
index:
IndexData
Returns
any
Private
_get
Type
Doc
Index
_get
Type
Doc
Index
(
event
:
RendererEvent
)
:
IndexData
Parameters
event:
RendererEvent
Returns
IndexData
Private
_write
Index
File
_write
Index
File
(
event
:
RendererEvent
, indexData
:
IndexData
, lunrIndex
:
any
)
:
void
Parameters
event:
RendererEvent
indexData:
IndexData
lunrIndex:
any
Returns
void
populate
Search
Index
populate
Search
Index
(
event
:
RendererEvent
)
:
void
Parameters
event:
RendererEvent
Returns
void
Getting
Started
Quick
Start
Creating
Pages
Page
Organization
Configuration
Configuration
File
Reflection
Navigation
Title
Search
Integration
Advanced
Content
Images
Code
Links
Page
Links
Themes
Built-
In
Theme
Custom
Themes
Development API
Constants
Links
Models
Options
Pages
Plugin
Rendering
Search
Theme
Utilities
Index
Data
Manager
Legacy
Search
Manager
Search
Index
Builder
constructor
_index
Data
Manager
_options
_build
Index
_get
Type
Doc
Index
_write
Index
File
populate
Search
Index
Search
Index
Parser
Search
Manager
Factory
Index
Data
Index
Data
Row
Search
Manager
Generated using
TypeDoc
Creates an instance of SearchManager