rluiten / elm-text-search / Index.Defaults

Defaults for indexes and configurations.

Index Storage Engine Version and Type

indexVersion : String

The version of index, for loading a saved index.

This is not the same as package version.

This needs to change if the encoded format changes. Be careful of updates to Trie package, if Trie encoding format changes this version needs to change as well.

elmTextSearchIndexType : String

The type of index defaults to using. It defines the default token transforms and filters.

Built in Transforms and Filters

defaultTransformFactories : List (Index.Model.TransformFactory doc)

Index default transform factories.

defaultFilterFactories : List (Index.Model.FilterFactory doc)

Index default filter factories.

defaultTokenTrimmerFuncCreator : Index.Model.TransformFactory doc

The default token trimmer transform function creator. Normally applied first in transform functions.

defaultStemmerFuncCreator : Index.Model.TransformFactory doc

The default token stemmer transform function creator.

defaultStopWordFilterFuncCreator : Index.Model.FilterFactory doc

The default stop word filter function creator.

defaultInitialTransformFactories : List (Index.Model.TransformFactory doc)

Index default transform factories that apply before filters.

Config type adapters

getDefaultIndexConfig : Index.Model.ModelSimpleConfig doc -> Index.Model.Config doc

Convert Index.Model.ModelSimpleConfig to Index.Model.Config Filling in default values for fields not in SimpleConfig This is the definition of the default index configuration.

getIndexSimpleConfig : Index.Model.IndexSimpleConfig doc -> Index.Model.ModelSimpleConfig doc

convert ElmTextSearch.IndexSimpleConfig to Index.Model.ModelSimpleConfig