Class SearchEngine

Singleton Registry dispatching document indexing and search operations across configured search engine providers.

Hierarchy (View Summary)

Core
- SearchEngine

Index

Constructors

constructor

new SearchEngine(): SearchEngine
Returns SearchEngine
Inherited from Core.constructor

Properties

`Protected` `Static`_engines

_engines: SearchEngineRegistry<any> = {}

`Static` `Readonly`classRegistry

classRegistry: { [key: string]: any } = {}

Dictionary holding registered active Quatrain models/components.

`Static`defaultEngine

defaultEngine: string = '@default'

Reference identifier for the primary default search engine.

`Static`logger

logger: any = ...

Domain-specific Core Logger instance.

`Static` `Readonly`logLevel

logLevel: DEBUG = LogLevel.DEBUG

System-wide base log verbosity.

`Static` `Readonly`me

me: string = ...

Identifying namespace for this core component.

`Static` `Readonly`storage

storage: typeof NodePersist = persist

Persistent key-value storage engine reference.

`Static` `Readonly`storagePrefix

storagePrefix: "core" = 'core'

Context prefix string for scoped storage keys.

Accessors

`Static`userClass

get userClass(): any
Returns any
Inherited from Core.userClass
- Defined in core/src/Core.ts:181
set userClass(cls: any): void
Parameters
- cls: any
Returns void
Inherited from Core.userClass
- Defined in core/src/Core.ts:185

Methods

`Static`addClass

addClass(name: string, obj: any): void
Maps a specific entity class to an active name so the factory reflection can locate it.
Parameters
- name: string
  Semantic registry name.
- obj: any
  Class constructor.
Returns void
Inherited from Core.addClass
- Defined in core/src/Core.ts:105

`Static`addConfig

addConfig(key: string, value: any): Promise<void>
Stores a primitive value durably in the core storage instance.
Parameters
- key: string
  Identification string.
- value: any
  Value.
Returns Promise<void>
Inherited from Core.addConfig
- Defined in core/src/Core.ts:79

`Static`addEngine

addEngine(
    engine: AbstractSearchEngineAdapter,
    alias?: string,
    setDefault?: boolean,
): void
Registers an instantiated search engine adapter into the registry.
Parameters
- engine: AbstractSearchEngineAdapter
  The instantiated search provider adapter.
- alias: string = ...
  Look-up name alias.
- setDefault: boolean = false
  Set as the primary search engine router if true.
Returns void
- Defined in searchengine/src/SearchEngine.ts:25

`Static`addLogger

addLogger(alias?: string): any
Injects a new logger block under a specific namespace alias.
Parameters
- alias: string = ...
  The logging context name.
Returns any
Instantiated LoggerAdapter.
Inherited from Core.addLogger
- Defined in core/src/Core.ts:35

`Static`debug

debug(...message: any): void
Triggers a debug log on the core logger.
Parameters
- ...message: any
  Content to log.
Returns void
Inherited from Core.debug
- Defined in core/src/Core.ts:203

`Static`definition

definition(
key: string,
): { manifest: { mandatory: boolean; type: StringConstructor } }
Deprecated: Reserved schema definition hook.
Parameters
- key: string
  The property block to generate.
Returns { manifest: { mandatory: boolean; type: StringConstructor } }
Field definitions block.
Inherited from Core.definition
- Defined in core/src/Core.ts:64

`Static`error

error(...message: any): void
Triggers an error log on the core logger.
Parameters
- ...message: any
  Content to log.
Returns void
Inherited from Core.error
- Defined in core/src/Core.ts:230

`Static` `Readonly`execPromise

execPromise(command: string, args?: any[], cwd?: string): Promise<any>
Execute an external command in a promise
Parameters
- command: string
- args: any[] = []
- cwd: string = ...
Returns Promise<any>
Promise
See
- https://stackoverflow.com/questions/46289682/how-to-wait-for-child-process-spawn-execution-with-async-await
- https://dzone.com/articles/understanding-execfile-spawn-exec-and-fork-in-node
Inherited from Core.execPromise
- Defined in core/src/Core.ts:127

`Static`getClass

getClass(name: string): any
Returns an injected class constructor by its registry identifier.
Parameters
- name: string
  The semantic name to resolve.
Returns any
Class definition.
Inherited from Core.getClass
- Defined in core/src/Core.ts:115

`Static`getConfig

getConfig(key: string): Promise<any>
Recovers a durably persisted value from the storage layer.
Parameters
- key: string
  The target identifier.
Returns Promise<any>
The recovered value.
Inherited from Core.getConfig
- Defined in core/src/Core.ts:92

`Static`getEngine

getEngine<T extends AbstractSearchEngineAdapter>(alias?: string): T
Retrieves an active search engine adapter from the registry by its alias.
Type Parameters
- T extends AbstractSearchEngineAdapter
Parameters
- alias: string = ...
  Adapter lookup name.
Returns T
Instantiated search engine provider.

Throws
Error if alias is not registered.
- Defined in searchengine/src/SearchEngine.ts:43

`Static` `Readonly`getSystemCommandPath

getSystemCommandPath(command: string): Promise<string>
Utility lookup to find executable paths in the system using which.
Parameters
- command: string
  The executable.
Returns Promise<string>
The resolved system path.
Inherited from Core.getSystemCommandPath
- Defined in core/src/Core.ts:168

`Static`indexDocument

indexDocument(doc: SearchDocument, alias?: string): Promise<void>
Indexes a document using the default search engine adapter.
Parameters
- doc: SearchDocument
  Document to index.
- alias: string = ...
  Optional engine alias override.
Returns Promise<void>
- Defined in searchengine/src/SearchEngine.ts:59

`Static`info

info(...message: any): void
Triggers an info log on the core logger.
Parameters
- ...message: any
  Content to log.
Returns void
Inherited from Core.info
- Defined in core/src/Core.ts:221

`Static`log

log(...message: any): void
Triggers a standard log on the core logger.
Parameters
- ...message: any
  Content to log.
Returns void
Inherited from Core.log
- Defined in core/src/Core.ts:194

`Static`search

search(
    query: string,
    options?: SearchQueryOptions,
    alias?: string,
): Promise<SearchResultItem[]>
Executes a query using the default search engine adapter.
Parameters
- query: string
  Free text search query string.
- Optionaloptions: SearchQueryOptions
  Search query parameters.
- alias: string = ...
  Optional engine alias override.
Returns Promise<SearchResultItem[]>
Matching search result items.
- Defined in searchengine/src/SearchEngine.ts:75

`Static`setLogLevel

setLogLevel(level: LogLevel): void
Mutates the underlying verbosity constraints.
Parameters
- level: LogLevel
  Active LogLevel filter.
Returns void
Inherited from Core.setLogLevel
- Defined in core/src/Core.ts:48

`Static`sleep

sleep(seconds?: number): Promise<unknown>
Execution suspension utility blocking the event loop context.
Parameters
- seconds: number = 1
  Duration count.
Returns Promise<unknown>
The promise to await.
Inherited from Core.sleep
- Defined in core/src/Core.ts:177

`Static` `Readonly`timestamp

timestamp(): string
Returns an ISO string representing the current time.

Returns string
Inherited from Core.timestamp
- Defined in core/src/Core.ts:56

`Static`trace

trace(...message: any): void
Triggers a trace log on the core logger.
Parameters
- ...message: any
  Content to log.
Returns void
Inherited from Core.trace
- Defined in core/src/Core.ts:239

`Static`warn

warn(...message: any): void
Triggers a warning log on the core logger.
Parameters
- ...message: any
  Content to log.
Returns void
Inherited from Core.warn
- Defined in core/src/Core.ts:212

Class SearchEngine

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns SearchEngine

Properties

Protected Static_engines

Static ReadonlyclassRegistry

StaticdefaultEngine

Staticlogger

Static ReadonlylogLevel

Static Readonlyme

Static Readonlystorage

Static ReadonlystoragePrefix

Accessors

StaticuserClass

Returns any

Parameters

Returns void

Methods

StaticaddClass

Parameters

Returns void

StaticaddConfig

Parameters

Returns Promise<void>

StaticaddEngine

Parameters

Returns void

StaticaddLogger

Parameters

Returns any

Staticdebug

Parameters

Returns void

Staticdefinition

Parameters

Returns { manifest: { mandatory: boolean; type: StringConstructor } }

Staticerror

Parameters

Returns void

Static ReadonlyexecPromise

Parameters

Returns Promise<any>

See

StaticgetClass

Parameters

Returns any

StaticgetConfig

Parameters

Returns Promise<any>

StaticgetEngine

Type Parameters

Parameters

Returns T

Throws

Static ReadonlygetSystemCommandPath

Parameters

Returns Promise<string>

StaticindexDocument

Parameters

Returns Promise<void>

Staticinfo

Parameters

Returns void

Staticlog

Parameters

Returns void

Staticsearch

Parameters

Returns Promise<SearchResultItem[]>

StaticsetLogLevel

Parameters

Returns void

Staticsleep

`Protected` `Static`_engines

`Static` `Readonly`classRegistry

`Static`defaultEngine

`Static`logger

`Static` `Readonly`logLevel

`Static` `Readonly`me

`Static` `Readonly`storage

`Static` `Readonly`storagePrefix

`Static`userClass

`Static`addClass

`Static`addConfig

`Static`addEngine

`Static`addLogger

`Static`debug

`Static`definition

`Static`error

`Static` `Readonly`execPromise

`Static`getClass

`Static`getConfig

`Static`getEngine

`Static` `Readonly`getSystemCommandPath

`Static`indexDocument

`Static`info

`Static`log

`Static`search

`Static`setLogLevel

`Static`sleep

`Static` `Readonly`timestamp

`Static`trace

`Static`warn