Function functionPropertyQuery

functionPropertyQuery<
    const T extends string,
    const K extends string,
    Q extends
        BaseQueryFormat & { filter?: readonly SlicingCriterion[]; type: T },
>(
    spec: {
        compute: (
            data: BasicQueryData,
            queries: readonly Q[],
        ) => Promise<Record<NodeId, boolean>>;
        noun: string;
        phrase: string;
        resultKey: K;
        title: string;
        type: T;
    },
): {
    asciiSummarizer: (
        formatter: OutputFormatter,
        processed: ReadonlyFlowrAnalysisProvider<KnownParser>,
        queryResults: BaseQueryResult,
        result: string[],
    ) => Promise<boolean>;
    completer: (
        line: readonly string[],
        startingNewArg: boolean,
        _config: FlowrConfig,
    ) => CommandCompletions;
    executor: (data: BasicQueryData, queries: readonly Q[]) => Promise<Result>;
    flattenInvolvedNodes: (queryResults: BaseQueryResult) => NodeId[];
    fromLine: (
        _output: ReplOutput,
        line: readonly string[],
        _config: FlowrConfig,
    ) => ParsedQueryLine<T>;
    schema: ObjectSchema<any>;
    syntax: `@${T} [(<crit>;...)] <code | file://path>`;
    title: string;
}
Defines an inspect-* query that states one boolean property per function definition, stored under resultKey.
Type Parameters
- const T extends string
- const K extends string
- Q extends BaseQueryFormat & { filter?: readonly SlicingCriterion[]; type: T }
Parameters
- spec: {
      compute: (
          data: BasicQueryData,
          queries: readonly Q[],
      ) => Promise<Record<NodeId, boolean>>;
      noun: string;
      phrase: string;
      resultKey: K;
      title: string;
      type: T;
  }
Returns {
    asciiSummarizer: (
        formatter: OutputFormatter,
        processed: ReadonlyFlowrAnalysisProvider<KnownParser>,
        queryResults: BaseQueryResult,
        result: string[],
    ) => Promise<boolean>;
    completer: (
        line: readonly string[],
        startingNewArg: boolean,
        _config: FlowrConfig,
    ) => CommandCompletions;
    executor: (data: BasicQueryData, queries: readonly Q[]) => Promise<Result>;
    flattenInvolvedNodes: (queryResults: BaseQueryResult) => NodeId[];
    fromLine: (
        _output: ReplOutput,
        line: readonly string[],
        _config: FlowrConfig,
    ) => ParsedQueryLine<T>;
    schema: ObjectSchema<any>;
    syntax: `@${T} [(<crit>;...)] <code | file://path>`;
    title: string;
}
- ReadonlyasciiSummarizer: (
      formatter: OutputFormatter,
      processed: ReadonlyFlowrAnalysisProvider<KnownParser>,
      queryResults: BaseQueryResult,
      result: string[],
  ) => Promise<boolean>
- Readonlycompleter: (
      line: readonly string[],
      startingNewArg: boolean,
      _config: FlowrConfig,
  ) => CommandCompletions
- Readonlyexecutor: (data: BasicQueryData, queries: readonly Q[]) => Promise<Result>
- ReadonlyflattenInvolvedNodes: (queryResults: BaseQueryResult) => NodeId[]
- ReadonlyfromLine: (
      _output: ReplOutput,
      line: readonly string[],
      _config: FlowrConfig,
  ) => ParsedQueryLine<T>
- Readonlyschema: ObjectSchema<any>
- Readonlysyntax: `@${T} [(<crit>;...)] <code | file://path>`
- Readonlytitle: string
- Defined in src/queries/query-function-property.ts:15

Function functionPropertyQuery

Type Parameters

Parameters

`Readonly`asciiSummarizer: (
    formatter: OutputFormatter,
    processed: ReadonlyFlowrAnalysisProvider<KnownParser>,
    queryResults: BaseQueryResult,
    result: string[],
) => Promise<boolean>

`Readonly`completer: (
    line: readonly string[],
    startingNewArg: boolean,
    _config: FlowrConfig,
) => CommandCompletions

`Readonly`executor: (data: BasicQueryData, queries: readonly Q[]) => Promise<Result>

`Readonly`flattenInvolvedNodes: (queryResults: BaseQueryResult) => NodeId[]

`Readonly`fromLine: (
    _output: ReplOutput,
    line: readonly string[],
    _config: FlowrConfig,
) => ParsedQueryLine<T>

`Readonly`schema: ObjectSchema<any>

`Readonly`syntax: `@${T} [(<crit>;...)] <code | file://path>`

`Readonly`title: string

Settings

Function functionPropertyQuery

Type Parameters

Parameters

ReadonlyasciiSummarizer: ( formatter: OutputFormatter, processed: ReadonlyFlowrAnalysisProvider<KnownParser>, queryResults: BaseQueryResult, result: string[],) => Promise<boolean>

Readonlycompleter: ( line: readonly string[], startingNewArg: boolean, _config: FlowrConfig,) => CommandCompletions

Readonlyexecutor: (data: BasicQueryData, queries: readonly Q[]) => Promise<Result>

ReadonlyflattenInvolvedNodes: (queryResults: BaseQueryResult) => NodeId[]

ReadonlyfromLine: ( _output: ReplOutput, line: readonly string[], _config: FlowrConfig,) => ParsedQueryLine<T>

Readonlyschema: ObjectSchema<any>

Readonlysyntax: `@${T} [(<crit>;...)] <code | file://path>`

Readonlytitle: string

Settings

`Readonly`asciiSummarizer: (
formatter: OutputFormatter,
processed: ReadonlyFlowrAnalysisProvider<KnownParser>,
queryResults: BaseQueryResult,
result: string[],
) => Promise<boolean>

`Readonly`completer: (
line: readonly string[],
startingNewArg: boolean,
_config: FlowrConfig,
) => CommandCompletions

`Readonly`executor: (data: BasicQueryData, queries: readonly Q[]) => Promise<Result>

`Readonly`flattenInvolvedNodes: (queryResults: BaseQueryResult) => NodeId[]

`Readonly`fromLine: (
_output: ReplOutput,
line: readonly string[],
_config: FlowrConfig,
) => ParsedQueryLine<T>

`Readonly`schema: ObjectSchema<any>

`Readonly`syntax: `@${T} [(<crit>;...)] <code | file://path>`

`Readonly`title: string