vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-07-01 07:40:10 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[lunr] Add missing lunr.generateStopWordFilter function (#21998)

Browse Source
This commit is contained in:
Sean Tan
2017-12-06 23:36:11 +08:00
committed by Andy
parent 7f0c54c130
commit 4f6ef35ca8
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
types/lunr/index.d.ts vendored
View File

@@ -626,6 +626,19 @@ declare namespace lunr {
*/
function stemmer(token: Token): Token;
/**
* lunr.generateStopWordFilter builds a stopWordFilter function from the provided
* list of stop words.
*
* The built in lunr.stopWordFilter is built using this generator and can be used
* to generate custom stopWordFilters for applications or non English languages.
*
* @param stopWords - The list of stop words
* @see lunr.Pipeline
* @see lunr.stopWordFilter
*/
function generateStopWordFilter(stopWords: string[]): PipelineFunction;
/**
* lunr.stopWordFilter is an English language stop word list filter, any words
* contained in the list will not be passed through the filter.