Debian Codegraph @

packages/search/lib/commands/EXPLAIN.ts

raw
1 import { Params, pushParamsArgs } from ".";
2
3 export const IS_READ_ONLY = true;
4
5 interface ExplainOptions {
6 PARAMS?: Params;
7 DIALECT?: number;
8 }
9
10 export function transformArguments(
11 index: string,
12 query: string,
13 options?: ExplainOptions
14 ): Array<string> {
15 const args = ['FT.EXPLAIN', index, query];
16
17 pushParamsArgs(args, options?.PARAMS);
18
19 if (options?.DIALECT) {
20 args.push('DIALECT', options.DIALECT.toString());
21 }
22
23 return args;
24 }
25
26 export declare function transformReply(): string;