Interface QueryDocumentation

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

Index

Properties

buildExplanation name? shortDescription type

Properties

`Readonly`buildExplanation

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

`Optional` `Readonly`name

name?: string

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

`Readonly`shortDescription

shortDescription: string

`Readonly`type

type: "active" | "virtual"