Called after each module execution.

Called after each module execution.

Adds the "position" metadata to the metadata allowlist in the search index, which enables position information for each search term in the search results at the expense of index size.

Called before each module execution.

Called before each module execution.

This allows you to customize the JavaScript file that this module creates.

This should not be called directly, instead call IExecutionContext.Execute() if you need to execute a module from within another module.

Executes the module.

Called after each module execution, even if an exception is thrown during execution.

Called after each module execution, even if an exception is thrown during execution.

Indicates whether the host should be automatically included in generated links (the default is false).

Indicates whether HTML should be removed from document content when the input document media type indicates the content is HTML (the default is true).

Changes the name of the client object in the generated JavaScript file.

Defines a search field and whether to include it in results.

Defines search fields and whether to include them in results.

Controls the output path of the search index file (by default the destination of the search index file is the same as the script file with a ".index.gz" extension, or ".index.json" extension if ZipIndexFile(bool) is false). or ).

Clears all fields from the search index.

Removes a field from the search index.

Sets an alternate reference key that will be used to get a unique identifier for each search metadata item.

Controls the output path of the results file that holds search field values as defined by Result (by default the destination of the search index file is the same as the script file with a ".results.json" extension).

Controls the output path of the script file (by default the destination of the script file is "search.js").

Use a custom delegate to get search items for each input document. Only the reference and search field keys will be retrieved from the returned item(s), all other values will be ignored (I.e. they won't be added to the search automatically).

Sets a custom metadata key to use to get search items from each document if the document provides search items via metadata.

Turns on stemming, which reduces words to their base form, using a default English stemmer. You can customize stemming and supply a stemming delegate using WithStemming(Func<string, string>). Note that turning on stemming reduces the effectiveness of wildcard searches and disables the default client-side typeahead search behavior in the generated JavaScript file.

Turns on stemming, which reduces words to their base form, using a custom stemming delegate. Note that turning on stemming reduces the effectiveness of wildcard searches and disables the default client-side typeahead search behavior in the generated JavaScript file.

Specifies stops words to use for the search index. By default a pre-defined set of English stop words are used.

Specifies an input file that contains stop words to use. The file should contain one stop word per line.

Indicates whether to gzip the index file (the default is true).

Indicates whether to gzip the results file (the default is true).