@orama/orama/dist/browser/utils.d.ts

A complete search engine and RAG pipeline in your browser, server, or edge network with support for full-text, vector, and hybrid search in less than 2kb.

import type { AnyDocument, GeosearchDistanceUnit, Optional, Results, SearchableValue, TokenScore } from './types.js';
export declare const isServer: boolean;
/**
 * This value can be increased up to 100_000
 * But i don't know if this value change from nodejs to nodejs
 * So I will keep a safer value here.
 */
export declare const MAX_ARGUMENT_FOR_STACK = 65535;
/**
 * This method is needed to used because of issues like: https://github.com/oramasearch/orama/issues/301
 * that issue is caused because the array that is pushed is huge (>100k)
 *
 * @example
 * ```ts
 * safeArrayPush(myArray, [1, 2])
 * ```
 */
export declare function safeArrayPush<T>(arr: T[], newArr: T[]): void;
export declare function sprintf(template: string, ...args: Array<string | number>): string;
export declare function formatBytes(bytes: number, decimals?: number): string;
export declare function isInsideWebWorker(): boolean;
export declare function isInsideNode(): boolean;
export declare function getNanosecondTimeViaPerformance(): bigint;
export declare function formatNanoseconds(value: number | bigint): string;
export declare function getNanosecondsTime(): bigint;
export declare function uniqueId(): string;
export declare function getOwnProperty<T = unknown>(object: Record<string, T>, property: string): T | undefined;
export declare function getTokenFrequency(token: string, tokens: string[]): number;
export declare function insertSortedValue(arr: TokenScore[], el: TokenScore, compareFn?: typeof sortTokenScorePredicate): TokenScore[];
export declare function sortTokenScorePredicate(a: TokenScore, b: TokenScore): number;
export declare function intersect<T>(arrays: Array<readonly T[]>): T[];
export declare function getDocumentProperties(doc: AnyDocument, paths: string[]): Record<string, SearchableValue>;
export declare function getNested<T = SearchableValue>(obj: object, path: string): Optional<T>;
export declare function flattenObject(obj: object, prefix?: string): AnyDocument;
export declare function convertDistanceToMeters(distance: number, unit: GeosearchDistanceUnit): number;
export declare function removeVectorsFromHits(searchResult: Results<AnyDocument>, vectorProperties: string[]): void;
export declare function isPromise(obj: any): obj is Promise<unknown>;
/**
 * Checks if the provided input is an async function or if the input is an array
 * containing at least one async function.
 *
 * @param func - A single function or an array of functions to check.
 *               Non-function values are ignored.
 * @returns `true` if the input is an async function or an array containing at least
 *          one async function, otherwise `false`.
 */
export declare function isAsyncFunction(func: any): boolean;
export declare function setIntersection<V>(...sets: Set<V>[]): Set<V>;
export declare function setUnion<V>(set1: Set<V> | undefined, set2: Set<V>): Set<V>;
export declare function sleep(ms: number): void;