Interface ShowQueryOptions

interface ShowQueryOptions {
    collapseQuery?: boolean;
    collapseResult?: boolean;
    ctx?: GeneralDocContext;
    files?: readonly { content: string; name: string }[];
    prepare?: (builder: FlowrAnalyzerBuilder) => void;
    shorthand?: string;
    showCode?: boolean;
}

Index

Properties

collapseQuery? collapseResult? ctx? files? prepare? shorthand? showCode?

Properties

`Optional` `Readonly`collapseQuery

collapseQuery?: boolean

`Optional` `Readonly`collapseResult

collapseResult?: boolean

`Optional` `Readonly`ctx

ctx?: GeneralDocContext

`Optional` `Readonly`files

files?: readonly { content: string; name: string }[]

additional in-memory files registered before the request, e.g. the targets of source(...) calls

`Optional` `Readonly`prepare

prepare?: (builder: FlowrAnalyzerBuilder) => void

hook to configure the analyzer, e.g. to pin a version so the generated output does not follow the generating machine

`Optional` `Readonly`shorthand

shorthand?: string

`Optional` `Readonly`showCode

showCode?: boolean