node-redis/packages/search/lib/commands/EXPLAIN.ts

import { RedisArgument, SimpleStringReply, Command } from '@redis/client/dist/lib/RESP/types';
import { Params, pushParamsArgs } from ".";

export interface FtExplainOptions {
  PARAMS?: Params;
  DIALECT?: number;
}

export default {
  FIRST_KEY_INDEX: undefined,
  IS_READ_ONLY: true,
  transformArguments(
    index: RedisArgument,
    query: RedisArgument,
    options?: FtExplainOptions
  ) {
    const args = ['FT.EXPLAIN', index, query];

    pushParamsArgs(args, options?.PARAMS);

    if (options?.DIALECT) {
      args.push('DIALECT', options.DIALECT.toString());
    }

    return args;
  },
  transformReply: undefined as unknown as () => SimpleStringReply
} as const satisfies Command;