Skip to main content
Version: Version 5 beta

Class: DocumentTextSearchService

Service for searching text within a document. Inherits functionality from the generic SearchService class, specifying parameters for text search and returning an array of DocumentTextSearchResult objects.

Extends

Constructors

new DocumentTextSearchService()

new DocumentTextSearchService(strategy): DocumentTextSearchService

Constructs a new SearchService instance with the specified search strategy.

Parameters

strategy: SearchStrategy<DocumentTextSearchParams, DocumentTextSearchResult[]>

The search strategy to be used for executing search operations.

Returns

DocumentTextSearchService

Inherited from

SearchService.constructor

Properties

strategy

strategy: SearchStrategy<DocumentTextSearchParams, DocumentTextSearchResult[]>

The search strategy associated with this search service.

Inherited from

SearchService.strategy

Methods

execute()

execute(params): SearchExecution<DocumentTextSearchResult[]>

Executes a search operation using the specified parameters.

Parameters

params: DocumentTextSearchParams

The parameters for the search operation.

Returns

SearchExecution<DocumentTextSearchResult[]>

A SearchExecution object representing the ongoing search operation.

Inherited from

SearchService.execute