Zvec Node.js API Reference
    Preparing search index...

    Interface ZVecInitOptions

    Configuration options for initializing Zvec globally.

    interface ZVecInitOptions {
        logType?: ZVecLogType;
        logLevel?: ZVecLogLevel;
        logDir?: string;
        logBaseName?: string;
        logFileSize?: number;
        logOverdueDays?: number;
        queryThreads?: number;
        optimizeThreads?: number;
        invertToForwardScanRatio?: number;
        bruteForceByKeysRatio?: number;
        ftsBruteForceByKeysRatio?: number;
        jiebaDictDir?: string;
    }
    Index

    Properties

    logType? logLevel? logDir? logBaseName? logFileSize? logOverdueDays? queryThreads? optimizeThreads? invertToForwardScanRatio? bruteForceByKeysRatio? ftsBruteForceByKeysRatio? jiebaDictDir?

    Properties

    logType?: ZVecLogType

    Type of log output.

    ZVecLogType.CONSOLE
    logLevel?: ZVecLogLevel

    Log level for messages.

    ZVecLogLevel.WARN
    logDir?: string

    Directory for log files (used when logType is 'FILE').

    './logs'
    logBaseName?: string

    Base name for log files (used when logType is 'FILE').

    'zvec.log'
    logFileSize?: number

    Maximum size of each log file in bytes (used when logType is 'FILE').

    2048
    logOverdueDays?: number

    Number of days to keep old log files (used when logType is 'FILE').

    7
    queryThreads?: number

    Number of threads for query execution.

    undefined // Let the system decide
    optimizeThreads?: number

    Number of threads for background tasks.

    undefined // Let the system decide
    invertToForwardScanRatio?: number

    Threshold to switch from inverted-index filtering to forward scan.

    undefined
    bruteForceByKeysRatio?: number

    Threshold to use brute-force key lookup over index lookup.

    undefined
    ftsBruteForceByKeysRatio?: number

    Threshold to switch FTS scan strategy for highly selective candidates.

    undefined
    jiebaDictDir?: string

    Directory containing jieba tokenizer dictionary files.

    undefined

    Settings

    Member Visibility

    On This Page

    Properties