ArgumentsDescription #

Copied to clipboard!

import { JSONObject } from "kuzzle-sdk";
/**
  * Type used to describe a predicate or task arguments
  */
export type ArgumentsDescription = {
  [name: string]: {
    /**
      * Argument type
      */
    type: "boolean" | "number" | "string" | JSONObject;
    /**
      * Argument description
      */
    description: string;
    /**
      * Makes the argument optional
      */
    optional?: true;
  };
};