Interface FrameworkOptions

src/options.ts:28–62

 * the framework.
 */
export interface FrameworkOptions {
  /**
   * The port on which this server listens to all HTTP requests.
   */
  port: string;
  /**
   * The name of the function within user's node module to execute. If such a
   * function is not defined, then falls back to 'function' name.
   */
  target: string;
  /**
   * The path to the source code file containing the client function.
   */
  sourceLocation: string;
  /**
   * The signature type of the client function.
   */
  signatureType: SignatureType;
  /**
   * Whether or not the --help CLI flag was provided.
   */
  printHelp: boolean;
  /**
   * Whether or not to enable execution id support.
   */
  enableExecutionId: boolean;
  /**
   * The request timeout.
   */
  timeoutMilliseconds: number;
  /**
   * Routes that should return a 404 without invoking the function.
   */
  ignoredRoutes: string | null;
}

/**
 * Helper class for parsing an configurable option from provided CLI flags