@eagleoutice/flowr/documentation/doc-util/doc-repl.d.ts

Static Dataflow Analyzer and Program Slicer for the R Programming Language

import type { KnownParser } from '../../r-bridge/parser';
/**
 *
 */
export declare function printReplHelpAsMarkdownTable(): string;
export interface DocumentReplSessionOptions {
    /** defaults to false and shows starting the repl */
    hideEntry?: boolean;
    /** defaults to false and allows access to the R session */
    allowRSessionAccess?: boolean;
    /** defaults to false and opens the details section by default */
    openOutput?: boolean;
    /** additional arguments to pass to the repl */
    args?: string;
}
export interface DocumentReplCommand {
    command: string;
    description: string;
}
/**
 * Creates a documented REPL session for the given commands.
 * This is intended for documentation purposes.
 */
export declare function documentReplSession(parser: KnownParser, commands: readonly DocumentReplCommand[], options?: DocumentReplSessionOptions): Promise<string>;