MCPcopy
hub / github.com/redis/node-redis / FtSearchOptions

Interface FtSearchOptions

packages/search/lib/commands/SEARCH.ts:29–64  ·  view source on GitHub ↗

Source from the content-addressed store, hash-verified

27}
28
29export interface FtSearchOptions {
30 VERBATIM?: boolean;
31 NOSTOPWORDS?: boolean;
32 INKEYS?: RedisVariadicArgument;
33 INFIELDS?: RedisVariadicArgument;
34 RETURN?: RedisVariadicArgument;
35 SUMMARIZE?: boolean | {
36 FIELDS?: RedisArgument | Array<RedisArgument>;
37 FRAGS?: number;
38 LEN?: number;
39 SEPARATOR?: RedisArgument;
40 };
41 HIGHLIGHT?: boolean | {
42 FIELDS?: RedisArgument | Array<RedisArgument>;
43 TAGS?: {
44 open: RedisArgument;
45 close: RedisArgument;
46 };
47 };
48 SLOP?: number;
49 TIMEOUT?: number;
50 INORDER?: boolean;
51 LANGUAGE?: RediSearchLanguage;
52 EXPANDER?: RedisArgument;
53 SCORER?: RedisArgument;
54 SORTBY?: RedisArgument | {
55 BY: RedisArgument;
56 DIRECTION?: 'ASC' | 'DESC';
57 };
58 LIMIT?: {
59 from: number | RedisArgument;
60 size: number | RedisArgument;
61 };
62 PARAMS?: FtSearchParams;
63 DIALECT?: number;
64}
65
66export function parseSearchOptions(parser: CommandParser, options?: FtSearchOptions) {
67 if (options?.VERBATIM) {

Callers

nothing calls this directly

Calls

no outgoing calls

Tested by

no test coverage detected