Member Junction
    Preparing search index...

    Class WebSearchEngine

    Singleton engine that routes a web search to a configured external provider.

    With an explicit Provider the engine resolves it by Name or DriverClass and then fails closed with a specific code — it never substitutes another vendor. The caller asked for a particular thing; quietly serving something else turns a deliberate choice into an invisible one.

    Without one it filters to Active, available and capability-satisfying drivers, orders by Priority ascending, and tries each in turn. A transient failure (rate limit, 5xx, timeout) moves to the next driver; a permanent failure stops the run, because a request every provider will reject should not cost five paid API calls and bury its own error message.

    Zero hits is a success. A narrow query legitimately matches nothing, and treating that as failure makes the engine retry a query that will keep returning nothing.

    await WebSearchEngine.Instance.Config(false, contextUser);
    const result = await WebSearchEngine.Instance.Search(
        { Query: 'association management trends', MaxResults: 10 },
        contextUser,
    );
    if (result.Success) {
        for (const hit of result.Hits) console.log(hit.Title, hit.URL);
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    AvailableProviders GlobalKey Instance

    Methods

    Config GetGlobalObjectStore GetRegisteredDrivers Search getInstance

    Constructors

    Accessors

    • get AvailableProviders(): readonly {
          DriverClass: string;
          Name: string;
          Priority: number;
      }[]

      Providers currently loaded and available, in priority order.

      Returns readonly { DriverClass: string; Name: string; Priority: number }[]

    • get GlobalKey(): string

      Returns string

    Methods

    • Load provider metadata and initialise every driver. Cheap no-op once loaded.

      Concurrent callers share one in-flight load rather than each issuing their own RunView — an agent fan-out can call Config from a dozen places in the same tick.

      Parameters

      • forceRefresh: boolean

        reload even if already configured (after an admin edits providers)

      • contextUser: UserInfo
      • Optionalprovider: IMetadataProvider

      Returns Promise<void>

    • The Global Object Store is a place to store global objects that need to be shared across the application. Depending on the execution environment, this could be the window object in a browser, or the global object in a node environment, or something else in other contexts. The key here is that in some cases static variables are not truly shared because it is possible that a given class might have copies of its code in multiple paths in a deployed application. This approach ensures that no matter how many code copies might exist, there is only one instance of the object in question by using the Global Object Store.

      Returns GlobalObjectStore

    • Returns the singleton instance of the class. If the instance does not exist, it is created and stored in the Global Object Store. If className is provided it will be used as part of the key in the Global Object Store, otherwise the actual class name will be used. NOTE: the class name used by default is the lowest level of the object hierarchy, so if you have a class that extends another class, the lowest level class name will be used.

      Type Parameters

      Parameters

      • this: new () => T
      • OptionalclassName: string

      Returns T

    Settings

    Member Visibility

    On This Page

    Selection
    Constructors
    Accessors
    Methods