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: FlowrConfigOptions,
    ) => CommandCompletions;
    executor: QueryExecutor<
        QueryArgumentsWithType<QueryType>,
        Promise<BaseQueryResult>,
    >;
    flattenInvolvedNodes: (
        queryResults: BaseQueryResult,
        query: readonly Query[],
    ) => NodeId[];
    fromLine?: (
        output: ReplOutput,
        splitLine: readonly string[],
        config: FlowrConfigOptions,
    ) => ParsedQueryLine<QueryType>;
    jsonFormatter?: (queryResults: BaseQueryResult) => object;
    schema: ObjectSchema;
}

Type Parameters

Properties

asciiSummarizer completer? executor flattenInvolvedNodes fromLine? jsonFormatter? schema

Properties

asciiSummarizer

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

Optionalcompleter

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

optional completion in, e.g., the repl

executor

executor: QueryExecutor<
    QueryArgumentsWithType<QueryType>,
    Promise<BaseQueryResult>,
>

flattenInvolvedNodes

flattenInvolvedNodes: (
    queryResults: BaseQueryResult,
    query: readonly Query[],
) => 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, an empty array can be returned.

OptionalfromLine

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

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

OptionaljsonFormatter

jsonFormatter?: (queryResults: BaseQueryResult) => object

schema

schema: ObjectSchema

Settings

Member Visibility

On This Page

Properties