graphdb-workbench/dist/api/services/autocomplete/autocomplete.service.d.ts

The web application for GraphDB APIs

import { Service } from '../../providers/service/service';
import { AutocompleteSearchResult } from '../../models/rdf-search/autocomplete-search-result';
/**
 * Service responsible for handling autocomplete functionality in the RDF search.
 */
export declare class AutocompleteService implements Service {
    /**
     * Performs an autocomplete search based on the provided search term.
     * This method fetches autocomplete suggestions from the REST service and maps
     * the results to the AutocompleteSearchResult.
     *
     * @param searchTerm - The string to use as the basis for autocomplete suggestions
     * @returns A promise that resolves to an AutocompleteSearchResult containing the matching suggestions
     */
    search(searchTerm: string): Promise<AutocompleteSearchResult>;
    /**
     * Checks if the autocomplete functionality is enabled.
     *
     * This method queries the AutocompleteRestService to determine
     * whether the autocomplete feature is currently enabled.
     *
     * @returns A promise that resolves to a boolean value.
     */
    isAutocompleteEnabled(): Promise<boolean>;
}