Interface FtSearchOptions

interface FtSearchOptions {
    DIALECT?: number;
    EXPANDER?: RedisArgument;
    HIGHLIGHT?: boolean | {
        FIELDS?: RedisArgument | RedisArgument[];
        TAGS?: {
            close: RedisArgument;
            open: RedisArgument;
        };
    };
    INFIELDS?: RedisVariadicArgument;
    INKEYS?: RedisVariadicArgument;
    INORDER?: boolean;
    LANGUAGE?: RediSearchLanguage;
    LIMIT?: {
        from: number | RedisArgument;
        size: number | RedisArgument;
    };
    NOSTOPWORDS?: boolean;
    PARAMS?: FtSearchParams;
    RETURN?: RedisVariadicArgument;
    SCORER?: RedisArgument;
    SLOP?: number;
    SORTBY?: RedisArgument | {
        BY: RedisArgument;
        DIRECTION?: "ASC" | "DESC";
    };
    SUMMARIZE?: boolean | {
        FIELDS?: RedisArgument | RedisArgument[];
        FRAGS?: number;
        LEN?: number;
        SEPARATOR?: RedisArgument;
    };
    TIMEOUT?: number;
    VERBATIM?: boolean;
}

Properties

DIALECT?: number
EXPANDER?: RedisArgument
HIGHLIGHT?: boolean | {
    FIELDS?: RedisArgument | RedisArgument[];
    TAGS?: {
        close: RedisArgument;
        open: RedisArgument;
    };
}

Type declaration

INORDER?: boolean
LIMIT?: {
    from: number | RedisArgument;
    size: number | RedisArgument;
}

Type declaration

NOSTOPWORDS?: boolean
SCORER?: RedisArgument
SLOP?: number
SORTBY?: RedisArgument | {
    BY: RedisArgument;
    DIRECTION?: "ASC" | "DESC";
}

Type declaration

SUMMARIZE?: boolean | {
    FIELDS?: RedisArgument | RedisArgument[];
    FRAGS?: number;
    LEN?: number;
    SEPARATOR?: RedisArgument;
}

Type declaration

TIMEOUT?: number
VERBATIM?: boolean

Generated using TypeDoc