ProtectedconstructorTrue once usearch has loaded on this thread.
StaticInstanceTrue when exact native search can serve this job (synchronous check).
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.
True when the HNSW index for a store has finished building.
Loads usearch once (later calls return the first result). Returns false — and logs why — when it is not installed or cannot load on this platform.
Loaded through require rather than import(): usearch's ESM build
locates its native binary by stack inspection, which yields a file://
URL that its directory walk cannot handle (it recurses until the stack
overflows). The CommonJS build uses __dirname and loads reliably. It is
resolved at runtime because the dependency is optional — a static import
would make this package fail to load wherever the binary is missing.
ProtectedRequireResolves the usearch module. Throws when it is not installed or its binary cannot load.
Approximate top-K through the store's HNSW index, with exact scores. Returns null when ANN does not apply, the index is still being built, or too few candidates survived filtering — the caller then searches exactly. Starts a background build the first time a large store is searched.
Exact top-K over every row of the view, or null when native search does not apply or could not prove its candidates complete — the caller then scans in JS.
Always the whole view from row 0: usearch reads a typed array from the
start of its underlying buffer and ignores byteOffset, so a subarray
(a partition, or a row used as the query) would silently be searched as
the wrong memory. Inputs that start part-way into a buffer are refused.
usearch threads (0 = all cores, 1 = this thread only)
Protected StaticgetReturns 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.
OptionalclassName: string
Generic, abstract base class for any scenario where we want to use a Singleton pattern. This base class abstracts away the complexity of ensuring a truly global singleton instance across multiple code paths in a deployed application. It uses a Global Object Store to ensure that only one instance of the class exists in the application even if the class has code imported into multiple execution paths (which is not optimal, of course, but can occur in some situations).