All files / src/resp/command resp-command.ts

100% Statements 1/1
100% Branches 0/0
100% Functions 0/0
100% Lines 1/1

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60                  1x                                                                                                    
import { DataType } from "../data/data-type";
import { Database } from "../data/database";
import { IRequest } from "../../server/request";
import { RedisToken } from "../protocol/redis-token";
 
/**
 * We use decorators to supply much of the information required
 * Thus we make these fields optional
 */
export abstract class IRespCommand {
  public blocking?: boolean;
 
 
  /**
   * Sign is used in commands with a compliment command.
   * The only current example is INCR/DECR.  Sign is 1 for INCR and -1 for DECR
   */
  public sign?: number;
 
 
  /**
   * Used in transactions to enqueue a command.
   */
  public txIgnore?: boolean;
 
 
  /**
   * Used when PUB/SUB is in effect.
   */
  public pubSubAllowed?: boolean;
 
 
  /**
   * Used for "database" commands to enforce type checking.
   */
  public dataType?: DataType;
 
 
  /**
   * Minimum number of parameters require.
   */
  public minParams?: number;
 
 
  /**
   * Maximum number of parameters allowed.  -1 for no maximum.
   */
  public maxParams?: number;
 
 
  public name?: string;
 
  /**
   * Every command must implement the execute method.
   * @param request The original request
   * @param db The optional database argument
   */
  public abstract execSync(request: IRequest, db?: Database): RedisToken | Promise<RedisToken>;
}