@eagleoutice/flowr - v2.13.2
    Preparing search index...

    Interface QueryDocumentation

    interface QueryDocumentation {
        buildExplanation: (
            shell: RShell,
            ctx: GeneralDocContext,
        ) => Promise<string>;
        functionFile: string;
        functionName: string;
        name?: string;
        shortDescription: string;
        type: "virtual" | "active";
    }
    Index

    Properties

    buildExplanation functionFile functionName name? shortDescription type

    Properties

    buildExplanation: (shell: RShell, ctx: GeneralDocContext) => Promise<string>
    functionFile: string

    Path to the file implementing the query function, the wiki generation will fail if this isn't found

    functionName: string
    name?: string

    only for virtual queries, active ones carry their SupportedQuery.title

    shortDescription: string
    type: "virtual" | "active"

    Settings

    Member Visibility

    On This Page

    Properties