Interface FlowrReplOptions

Options for the repl function.

interface FlowrReplOptions {
    allowRSessionAccess?: boolean;
    analyzer: FlowrAnalyzer;
    historyFile?: string;
    output?: ReplOutput;
    rl?: Interface;
    [key: string]: unknown;
}

Hierarchy (View Summary)

Indexable

  • [key: string]: unknown

Hierarchy-Diagram

UML class diagram of FlowrReplOptions

Properties

allowRSessionAccess? analyzer historyFile? output? rl?

Properties

Optional ReadonlyallowRSessionAccess

allowRSessionAccess?: boolean

If true, allows the execution of arbitrary R code. This is a security risk, as it allows the execution of arbitrary R code.

Readonlyanalyzer

analyzer: FlowrAnalyzer

The flowR analyzer to use.

Optional ReadonlyhistoryFile

historyFile?: string

The file to use for persisting the repl's history. Passing undefined causes history not to be saved.

Optional Readonlyoutput

output?: ReplOutput

Defines two methods that every function in the repl uses to output its data.

Optional Readonlyrl

rl?: Interface

A potentially customized readline interface to be used for the repl to read from the user, we write the output with the output interface.

  • If you want to provide a custom one but use the same completer, refer to replCompleter.

Settings

Member Visibility

On This Page

Properties