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? EXPANDER? HIGHLIGHT? INFIELDS? INKEYS? INORDER? LANGUAGE? LIMIT? NOSTOPWORDS? PARAMS? RETURN? SCORER? SLOP? SORTBY? SUMMARIZE? TIMEOUT? VERBATIM?

Properties

Optional DIALECT

DIALECT?: number

Optional EXPANDER

EXPANDER?: RedisArgument

Optional HIGHLIGHT

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

Type declaration

Optional INFIELDS

INFIELDS?: RedisVariadicArgument

Optional INKEYS

INKEYS?: RedisVariadicArgument

Optional INORDER

INORDER?: boolean

Optional LANGUAGE

LANGUAGE?: RediSearchLanguage

Optional LIMIT

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

Type declaration

Optional NOSTOPWORDS

NOSTOPWORDS?: boolean

Optional PARAMS

PARAMS?: FtSearchParams

Optional RETURN

RETURN?: RedisVariadicArgument

Optional SCORER

SCORER?: RedisArgument

Optional SLOP

SLOP?: number

Optional SORTBY

SORTBY?: RedisArgument | {
    BY: RedisArgument;
    DIRECTION?: "ASC" | "DESC";
}

Type declaration

Optional SUMMARIZE

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

Type declaration

Optional TIMEOUT

TIMEOUT?: number

Optional VERBATIM

VERBATIM?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc