Class Repl

constructor

• new Repl(
      options?: { compiler?: Compiler; historyFilePath?: string } & ReplOptions,
  ): Repl

  Creates a new REPL instance with optional configuration

  Parameters

  • Optionaloptions: { compiler?: Compiler; historyFilePath?: string } & ReplOptions

    Configuration options for the REPL

    • Optionalcompiler?: Compiler

      Custom compiler for transforming user input

    • OptionalhistoryFilePath?: string

      Path to store command history

    • compiler

      Custom compiler for transforming user input

    • historyFilePath

      Path to store command history

  Returns Repl

  Example

  const repl = new Repl({
    historyFilePath: '.repl_history',
    compiler: myTypeScriptCompiler
  })
  Copy

colors

Optionalserver

notify

• notify(message: string): void

  Notify by writing to the console

  Parameters

  • message: string

    The message to display

  Returns void

  Example

  repl.notify('Server connected successfully')
  Copy

ready

• ready(callback: (repl: Repl) => void): this

  Register a callback to be invoked once the server is ready

  Parameters

  • callback: (repl: Repl) => void

    Function to call when the REPL is ready

  Returns this

  Example

  repl.ready((repl) => {
    repl.notify('REPL is ready!')
  })
  Copy

addMethod

• addMethod(name: string, handler: MethodCallback, options?: MethodOptions): this

  Register a custom loader function to be added to the context

  Parameters

  • name: string

    The name of the method

  • handler: MethodCallback

    The function to execute

  • Optionaloptions: MethodOptions

    Optional configuration for the method

  Returns this

  Example

  repl.addMethod('greet', (repl, name) => {
    return `Hello ${name}!`
  }, {
    description: 'Greets a person by name',
    usage: 'greet (name)'
  })
  Copy

getMethods

• getMethods(): {
      [name: string]: {
          handler: MethodCallback;
          options: MethodOptions & { width: number };
      };
  }

  Returns the collection of registered methods

  Returns {
      [name: string]: {
          handler: MethodCallback;
          options: MethodOptions & { width: number };
      };
  }

  Example

  const methods = repl.getMethods()
  console.log(Object.keys(methods)) // ['clear', 'p', 'myCustomMethod']
  Copy

useCompiler

• useCompiler(compiler: Compiler): this

  Register a compiler. Make sure register the compiler before calling the start method

  Parameters

  • compiler: Compiler

    The compiler instance to use for transforming code

  Returns this

  Example

  const tsCompiler = {
    compile: (code, filename) => ts.transpile(code),
    supportsTypescript: true
  }
  repl.useCompiler(tsCompiler)
  Copy

start

• start(context?: Record<string, any>): Repl

  Start the REPL server

  Parameters

  • Optionalcontext: Record<string, any>

    Optional initial context to populate the REPL with

  Returns Repl

  Example

  repl.start({
    db: databaseConnection,
    utils: myUtilities
  })
  Copy