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

    Interface SupportedQuery<QueryType>

    interface SupportedQuery<
        QueryType extends BaseQueryFormat["type"] = BaseQueryFormat["type"],
    > {
        asciiSummarizer: (
            formatter: OutputFormatter,
            analyzer: ReadonlyFlowrAnalysisProvider,
            queryResults: BaseQueryResult,
            resultStrings: string[],
            query: readonly Query[],
        ) => AsyncOrSync<boolean>;
        completer?: (
            splitLine: readonly string[],
            startingNewArg: boolean,
            config: FlowrConfig,
        ) => CommandCompletions;
        executor: QueryExecutor<
            QueryArgumentsWithType<QueryType>,
            Promise<BaseQueryResult>,
        >;
        flattenInvolvedNodes?: (
            queryResults: BaseQueryResult,
            query: readonly Query[],
            certainty?: LintingResultCertainty,
        ) => NodeId[];
        fromLine?: (
            output: ReplOutput,
            splitLine: readonly string[],
            config: FlowrConfig,
        ) => ParsedQueryLine<QueryType>;
        jsonFormatter?: (queryResults: BaseQueryResult) => object;
        perQueryResults?: true;
        schema: ObjectSchema;
        syntax?: string;
        title: string;
    }

    Type Parameters

    Index
    asciiSummarizer completer? executor flattenInvolvedNodes? fromLine? jsonFormatter? perQueryResults? schema syntax? title
    asciiSummarizer: (
        formatter: OutputFormatter,
        analyzer: ReadonlyFlowrAnalysisProvider,
        queryResults: BaseQueryResult,
        resultStrings: string[],
        query: readonly Query[],
    ) => AsyncOrSync<boolean>

    Generates an ASCII summary of the query result to be printed in, e.g., the REPL.

    Type Declaration

    completer?: (
        splitLine: readonly string[],
        startingNewArg: boolean,
        config: FlowrConfig,
    ) => CommandCompletions

    optional completion in, e.g., the repl

    executor: QueryExecutor<
        QueryArgumentsWithType<QueryType>,
        Promise<BaseQueryResult>,
    >
    flattenInvolvedNodes?: (
        queryResults: BaseQueryResult,
        query: readonly Query[],
        certainty?: LintingResultCertainty,
    ) => NodeId[]

    Flattens the involved query nodes to be added to a flowR search when the fromQuery function is used based on the given result after this query is executed. If this query does not involve any nodes, this can be omitted.

    fromLine?: (
        output: ReplOutput,
        splitLine: readonly string[],
        config: FlowrConfig,
    ) => ParsedQueryLine<QueryType>

    optional query construction from an, e.g., repl line

    jsonFormatter?: (queryResults: BaseQueryResult) => object
    perQueryResults?: true

    each query of this type reports exactly one entry in the results of its result, which Query.one answers with

    schema: ObjectSchema
    syntax?: string

    optional one-line usage of the repl @-shorthand fromLine accepts, shown by :query ?<type>

    title: string

    the human-readable name, e.g. Call-Context Query; also names its wiki page, see queryWikiPage

    Settings
    Member Visibility

    On This Page
    Properties