interactive-prompt.md

• InteractivePrompt (interface)
  • InteractivePrompt.prompt (function property)
  • InteractivePrompt.printInput (function property)
  • InteractivePrompt.historyFileName (string property)
  • InteractivePrompt.getCompletions (function property)
  • InteractivePrompt.handleInput (function property)
  • InteractivePrompt.start (method)
• InteractivePromptConstructor (interface)
  • InteractivePromptConstructor new(...) (construct signature)
  • InteractivePromptConstructor.prototype (InteractivePrompt property)
• InteractivePrompt (InteractivePromptConstructor)

InteractivePrompt (interface)

This API is a work-in-progress and is subject to change at any time.

interface InteractivePrompt {
  prompt?: () => string;
  printInput?: (input: string) => void;
  historyFileName?: string;
  getCompletions?: (
    line: string,
    pos: number,
  ) => {
    tab: Array<string>;
    pos: number;
    ctx: {
      [key: string | number | symbol]: any;
    };
  };
  handleInput: (input: string) => void;
  start(): void;
}

InteractivePrompt.prompt (function property)

prompt?: () => string;

InteractivePrompt.printInput (function property)

printInput?: (input: string) => void;

InteractivePrompt.historyFileName (string property)

historyFileName?: string;

InteractivePrompt.getCompletions (function property)

getCompletions?: (line: string, pos: number) => {
  tab: Array<string>;
  pos: number;
  ctx: {
    [key: string | number | symbol]: any;
  };
};

InteractivePrompt.handleInput (function property)

handleInput: (input: string) => void;

InteractivePrompt.start (method)

start(): void;

InteractivePromptConstructor (interface)

This API is a work-in-progress and is subject to change at any time.

interface InteractivePromptConstructor {
  new (
    handleInput: (input: string) => void,
    options?: {
      prompt?: () => string;
      printInput?: (input: string) => void;
      historyFileName?: string;
      getCompletions?: (
        line: string,
        pos: number,
      ) => {
        tab: Array<string>;
        pos: number;
        ctx: {
          [key: string | number | symbol]: any;
        };
      };
    },
  ): InteractivePrompt;
  prototype: InteractivePrompt;
}

InteractivePromptConstructor new(...) (construct signature)

new (handleInput: (input: string) => void, options?: {
  prompt?: () => string;
  printInput?: (input: string) => void;
  historyFileName?: string;
  getCompletions?: (line: string, pos: number) => {
    tab: Array<string>;
    pos: number;
    ctx: {
      [key: string | number | symbol]: any;
    };
  };
}): InteractivePrompt;

InteractivePromptConstructor.prototype (InteractivePrompt property)

prototype: InteractivePrompt;

InteractivePrompt (InteractivePromptConstructor)

This API is a work-in-progress and is subject to change at any time.

var InteractivePrompt: InteractivePromptConstructor;