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

    Interface FlowrSearchElement<Info>

    Yes, for now we do technically not need a wrapper around the RNode, but this allows us to attach caches etc. just for the respective search.

    interface FlowrSearchElement<Info> {
        enrichments?: {
            "call-targets"?: CallTargetsContent;
            "cfg-information"?: { isReachable: boolean | undefined; isRoot: boolean };
            "last-call"?: LastCallContent;
            "query-data"?: QueryDataElementContent;
            roxygen?: {
                documentation: (
                    | { inherited?: boolean; type: Aliases; value: string[] }
                    | { inherited?: boolean; type: Backref; value: string }
                    | { inherited?: boolean; type: Concept; value: string }
                    | { inherited?: boolean; type: Family; value: string }
                    | { inherited?: boolean; type: Keywords; value: string[] }
                    | { inherited?: boolean; type: References; value: string }
                    | { inherited?: boolean; type: SeeAlso; value: string[] }
                    | { inherited?: boolean; type: EvalNamespace; value: string }
                    | { inherited?: boolean; type: Export }
                    | { inherited?: boolean; type: ExportClass; value: string }
                    | { inherited?: boolean; type: ExportMethod; value: string }
                    | { inherited?: boolean; type: ExportPattern; value: string }
                    | { inherited?: boolean; type: ExportS3Method; value: string }
                    | { inherited?: boolean; type: Import; value: string }
                    | {
                        inherited?: boolean;
                        type: ImportClassesFrom;
                        value: { classes: string[]; package: string };
                    }
                    | {
                        inherited?: boolean;
                        type: ImportMethodsFrom;
                        value: { methods: string[]; package: string };
                    }
                    | {
                        inherited?: boolean;
                        type: ImportFrom;
                        value: { package: string; symbols: string[] };
                    }
                    | { inherited?: boolean; type: RawNamespace; value: string }
                    | { inherited?: boolean; type: UseDynLib; value: string }
                    | { inherited?: boolean; type: Md }
                    | { inherited?: boolean; type: NoMd }
                    | {
                        inherited?: boolean;
                        type: Section;
                        value: { content: string; title: string };
                    }
                    | {
                        inherited?: boolean;
                        type: Field;
                        value: { description: string; name: string };
                    }
                    | { inherited?: boolean; type: Format; value: string }
                    | {
                        inherited?: boolean;
                        type: Method;
                        value: { class: string; generic: string };
                    }
                    | {
                        inherited?: boolean;
                        type: Slot;
                        value: { description: string; name: string };
                    }
                    | { inherited?: boolean; type: Source; value: string }
                    | { inherited?: boolean; type: Description; value: string }
                    | { inherited?: boolean; type: Details; value: string }
                    | { inherited?: boolean; type: Example; value: string }
                    | { inherited?: boolean; type: Examples; value: string }
                    | {
                        inherited?: boolean;
                        type: ExamplesIf;
                        value: { condition: string; content: string };
                    }
                    | { inherited?: boolean; type: NoRd }
                    | {
                        inherited?: boolean;
                        type: Param;
                        value: { description: string; name: string };
                    }
                    | { inherited?: boolean; type: RawRd; value: string }
                    | { inherited?: boolean; type: Return | Returns; value: string }
                    | { inherited?: boolean; type: Title; value: string }
                    | { inherited?: boolean; type: Usage; value: string }
                    | {
                        inherited?: boolean;
                        type: DescribeIn;
                        value: { description: string; dest: string };
                    }
                    | { inherited?: boolean; type: Eval; value: string }
                    | { inherited?: boolean; type: EvalRd; value: string }
                    | { inherited?: boolean; type: IncludeRmd; value: string }
                    | {
                        inherited?: boolean;
                        type: Inherit;
                        value: { components: string[]; source: string };
                    }
                    | {
                        inherited?: boolean;
                        type: InheritDotParams;
                        value: { args: string[]; source: string };
                    }
                    | { inherited?: boolean; type: InheritParams; value: string }
                    | {
                        inherited?: boolean;
                        type: InheritSection;
                        value: { section: string; source: string };
                    }
                    | { inherited?: boolean; type: Order; value: number
                    | undefined }
                    | { inherited?: boolean; type: RdName; value: string }
                    | { inherited?: boolean; type: Template; value: string }
                    | {
                        inherited?: boolean;
                        type: TemplateVar;
                        value: { name: string; value: string };
                    }
                    | { inherited?: boolean; type: Author; value: string }
                    | {
                        inherited?: boolean;
                        type: Unknown;
                        value: { content: string; tag: string };
                    }
                    | { inherited?: boolean; type: DocType; value: string }
                    | { inherited?: boolean; type: Name; value: string }
                    | { inherited?: boolean; type: Text; value: string }
                )[];
                tags: {
                    aliases?: { inherited?: boolean; type: Aliases; value: string[] }[];
                    author?: { inherited?: boolean; type: Author; value: string }[];
                    backref?: { inherited?: boolean; type: Backref; value: string }[];
                    concept?: { inherited?: boolean; type: Concept; value: string }[];
                    describeIn?: {
                        inherited?: boolean;
                        type: DescribeIn;
                        value: { description: string; dest: string };
                    }[];
                    description?: { inherited?: boolean; type: Description; value: string }[];
                    details?: { inherited?: boolean; type: Details; value: string }[];
                    docType?: { inherited?: boolean; type: DocType; value: string }[];
                    eval?: { inherited?: boolean; type: Eval; value: string }[];
                    evalNamespace?: {
                        inherited?: boolean;
                        type: EvalNamespace;
                        value: string;
                    }[];
                    evalRd?: { inherited?: boolean; type: EvalRd; value: string }[];
                    example?: { inherited?: boolean; type: Example; value: string }[];
                    examples?: { inherited?: boolean; type: Examples; value: string }[];
                    examplesIf?: {
                        inherited?: boolean;
                        type: ExamplesIf;
                        value: { condition: string; content: string };
                    }[];
                    export?: { inherited?: boolean; type: Export }[];
                    exportClass?: { inherited?: boolean; type: ExportClass; value: string }[];
                    exportMethod?: {
                        inherited?: boolean;
                        type: ExportMethod;
                        value: string;
                    }[];
                    exportPattern?: {
                        inherited?: boolean;
                        type: ExportPattern;
                        value: string;
                    }[];
                    exportS3Method?: {
                        inherited?: boolean;
                        type: ExportS3Method;
                        value: string;
                    }[];
                    family?: { inherited?: boolean; type: Family; value: string }[];
                    field?: {
                        inherited?: boolean;
                        type: Field;
                        value: { description: string; name: string };
                    }[];
                    format?: { inherited?: boolean; type: Format; value: string }[];
                    import?: { inherited?: boolean; type: Import; value: string }[];
                    importClassesFrom?: {
                        inherited?: boolean;
                        type: ImportClassesFrom;
                        value: { classes: string[]; package: string };
                    }[];
                    importFrom?: {
                        inherited?: boolean;
                        type: ImportFrom;
                        value: { package: string; symbols: string[] };
                    }[];
                    importMethodsFrom?: {
                        inherited?: boolean;
                        type: ImportMethodsFrom;
                        value: { methods: string[]; package: string };
                    }[];
                    includeRmd?: { inherited?: boolean; type: IncludeRmd; value: string }[];
                    inherit?: {
                        inherited?: boolean;
                        type: Inherit;
                        value: { components: string[]; source: string };
                    }[];
                    inheritDotParams?: {
                        inherited?: boolean;
                        type: InheritDotParams;
                        value: { args: string[]; source: string };
                    }[];
                    inheritParams?: {
                        inherited?: boolean;
                        type: InheritParams;
                        value: string;
                    }[];
                    inheritSection?: {
                        inherited?: boolean;
                        type: InheritSection;
                        value: { section: string; source: string };
                    }[];
                    keywords?: { inherited?: boolean; type: Keywords; value: string[] }[];
                    md?: { inherited?: boolean; type: Md }[];
                    method?: {
                        inherited?: boolean;
                        type: Method;
                        value: { class: string; generic: string };
                    }[];
                    name?: { inherited?: boolean; type: Name; value: string }[];
                    noMd?: { inherited?: boolean; type: NoMd }[];
                    noRd?: { inherited?: boolean; type: NoRd }[];
                    order?: { inherited?: boolean; type: Order; value: number | undefined }[];
                    param?: {
                        inherited?: boolean;
                        type: Param;
                        value: { description: string; name: string };
                    }[];
                    rawNamespace?: {
                        inherited?: boolean;
                        type: RawNamespace;
                        value: string;
                    }[];
                    rawRd?: { inherited?: boolean; type: RawRd; value: string }[];
                    rdname?: { inherited?: boolean; type: RdName; value: string }[];
                    references?: { inherited?: boolean; type: References; value: string }[];
                    return?: { inherited?: boolean; type: Return; value: string }[];
                    returns?: { inherited?: boolean; type: Returns; value: string }[];
                    section?: {
                        inherited?: boolean;
                        type: Section;
                        value: { content: string; title: string };
                    }[];
                    seealso?: { inherited?: boolean; type: SeeAlso; value: string[] }[];
                    slot?: {
                        inherited?: boolean;
                        type: Slot;
                        value: { description: string; name: string };
                    }[];
                    source?: { inherited?: boolean; type: Source; value: string }[];
                    template?: { inherited?: boolean; type: Template; value: string }[];
                    templateVar?: {
                        inherited?: boolean;
                        type: TemplateVar;
                        value: { name: string; value: string };
                    }[];
                    text?: { inherited?: boolean; type: Text; value: string }[];
                    title?: { inherited?: boolean; type: Title; value: string }[];
                    unknown?: {
                        inherited?: boolean;
                        type: Unknown;
                        value: { content: string; tag: string };
                    }[];
                    usage?: { inherited?: boolean; type: Usage; value: string }[];
                    useDynLib?: { inherited?: boolean; type: UseDynLib; value: string }[];
                };
                [key: string]: unknown;
            };
        };
        node: RNode<Info>;
    }

    Type Parameters

    • Info
    Index

    Properties

    Properties

    enrichments?: {
        "call-targets"?: CallTargetsContent;
        "cfg-information"?: { isReachable: boolean | undefined; isRoot: boolean };
        "last-call"?: LastCallContent;
        "query-data"?: QueryDataElementContent;
        roxygen?: {
            documentation: (
                | { inherited?: boolean; type: Aliases; value: string[] }
                | { inherited?: boolean; type: Backref; value: string }
                | { inherited?: boolean; type: Concept; value: string }
                | { inherited?: boolean; type: Family; value: string }
                | { inherited?: boolean; type: Keywords; value: string[] }
                | { inherited?: boolean; type: References; value: string }
                | { inherited?: boolean; type: SeeAlso; value: string[] }
                | { inherited?: boolean; type: EvalNamespace; value: string }
                | { inherited?: boolean; type: Export }
                | { inherited?: boolean; type: ExportClass; value: string }
                | { inherited?: boolean; type: ExportMethod; value: string }
                | { inherited?: boolean; type: ExportPattern; value: string }
                | { inherited?: boolean; type: ExportS3Method; value: string }
                | { inherited?: boolean; type: Import; value: string }
                | {
                    inherited?: boolean;
                    type: ImportClassesFrom;
                    value: { classes: string[]; package: string };
                }
                | {
                    inherited?: boolean;
                    type: ImportMethodsFrom;
                    value: { methods: string[]; package: string };
                }
                | {
                    inherited?: boolean;
                    type: ImportFrom;
                    value: { package: string; symbols: string[] };
                }
                | { inherited?: boolean; type: RawNamespace; value: string }
                | { inherited?: boolean; type: UseDynLib; value: string }
                | { inherited?: boolean; type: Md }
                | { inherited?: boolean; type: NoMd }
                | {
                    inherited?: boolean;
                    type: Section;
                    value: { content: string; title: string };
                }
                | {
                    inherited?: boolean;
                    type: Field;
                    value: { description: string; name: string };
                }
                | { inherited?: boolean; type: Format; value: string }
                | {
                    inherited?: boolean;
                    type: Method;
                    value: { class: string; generic: string };
                }
                | {
                    inherited?: boolean;
                    type: Slot;
                    value: { description: string; name: string };
                }
                | { inherited?: boolean; type: Source; value: string }
                | { inherited?: boolean; type: Description; value: string }
                | { inherited?: boolean; type: Details; value: string }
                | { inherited?: boolean; type: Example; value: string }
                | { inherited?: boolean; type: Examples; value: string }
                | {
                    inherited?: boolean;
                    type: ExamplesIf;
                    value: { condition: string; content: string };
                }
                | { inherited?: boolean; type: NoRd }
                | {
                    inherited?: boolean;
                    type: Param;
                    value: { description: string; name: string };
                }
                | { inherited?: boolean; type: RawRd; value: string }
                | { inherited?: boolean; type: Return | Returns; value: string }
                | { inherited?: boolean; type: Title; value: string }
                | { inherited?: boolean; type: Usage; value: string }
                | {
                    inherited?: boolean;
                    type: DescribeIn;
                    value: { description: string; dest: string };
                }
                | { inherited?: boolean; type: Eval; value: string }
                | { inherited?: boolean; type: EvalRd; value: string }
                | { inherited?: boolean; type: IncludeRmd; value: string }
                | {
                    inherited?: boolean;
                    type: Inherit;
                    value: { components: string[]; source: string };
                }
                | {
                    inherited?: boolean;
                    type: InheritDotParams;
                    value: { args: string[]; source: string };
                }
                | { inherited?: boolean; type: InheritParams; value: string }
                | {
                    inherited?: boolean;
                    type: InheritSection;
                    value: { section: string; source: string };
                }
                | { inherited?: boolean; type: Order; value: number
                | undefined }
                | { inherited?: boolean; type: RdName; value: string }
                | { inherited?: boolean; type: Template; value: string }
                | {
                    inherited?: boolean;
                    type: TemplateVar;
                    value: { name: string; value: string };
                }
                | { inherited?: boolean; type: Author; value: string }
                | {
                    inherited?: boolean;
                    type: Unknown;
                    value: { content: string; tag: string };
                }
                | { inherited?: boolean; type: DocType; value: string }
                | { inherited?: boolean; type: Name; value: string }
                | { inherited?: boolean; type: Text; value: string }
            )[];
            tags: {
                aliases?: { inherited?: boolean; type: Aliases; value: string[] }[];
                author?: { inherited?: boolean; type: Author; value: string }[];
                backref?: { inherited?: boolean; type: Backref; value: string }[];
                concept?: { inherited?: boolean; type: Concept; value: string }[];
                describeIn?: {
                    inherited?: boolean;
                    type: DescribeIn;
                    value: { description: string; dest: string };
                }[];
                description?: { inherited?: boolean; type: Description; value: string }[];
                details?: { inherited?: boolean; type: Details; value: string }[];
                docType?: { inherited?: boolean; type: DocType; value: string }[];
                eval?: { inherited?: boolean; type: Eval; value: string }[];
                evalNamespace?: {
                    inherited?: boolean;
                    type: EvalNamespace;
                    value: string;
                }[];
                evalRd?: { inherited?: boolean; type: EvalRd; value: string }[];
                example?: { inherited?: boolean; type: Example; value: string }[];
                examples?: { inherited?: boolean; type: Examples; value: string }[];
                examplesIf?: {
                    inherited?: boolean;
                    type: ExamplesIf;
                    value: { condition: string; content: string };
                }[];
                export?: { inherited?: boolean; type: Export }[];
                exportClass?: { inherited?: boolean; type: ExportClass; value: string }[];
                exportMethod?: { inherited?: boolean; type: ExportMethod; value: string }[];
                exportPattern?: {
                    inherited?: boolean;
                    type: ExportPattern;
                    value: string;
                }[];
                exportS3Method?: {
                    inherited?: boolean;
                    type: ExportS3Method;
                    value: string;
                }[];
                family?: { inherited?: boolean; type: Family; value: string }[];
                field?: {
                    inherited?: boolean;
                    type: Field;
                    value: { description: string; name: string };
                }[];
                format?: { inherited?: boolean; type: Format; value: string }[];
                import?: { inherited?: boolean; type: Import; value: string }[];
                importClassesFrom?: {
                    inherited?: boolean;
                    type: ImportClassesFrom;
                    value: { classes: string[]; package: string };
                }[];
                importFrom?: {
                    inherited?: boolean;
                    type: ImportFrom;
                    value: { package: string; symbols: string[] };
                }[];
                importMethodsFrom?: {
                    inherited?: boolean;
                    type: ImportMethodsFrom;
                    value: { methods: string[]; package: string };
                }[];
                includeRmd?: { inherited?: boolean; type: IncludeRmd; value: string }[];
                inherit?: {
                    inherited?: boolean;
                    type: Inherit;
                    value: { components: string[]; source: string };
                }[];
                inheritDotParams?: {
                    inherited?: boolean;
                    type: InheritDotParams;
                    value: { args: string[]; source: string };
                }[];
                inheritParams?: {
                    inherited?: boolean;
                    type: InheritParams;
                    value: string;
                }[];
                inheritSection?: {
                    inherited?: boolean;
                    type: InheritSection;
                    value: { section: string; source: string };
                }[];
                keywords?: { inherited?: boolean; type: Keywords; value: string[] }[];
                md?: { inherited?: boolean; type: Md }[];
                method?: {
                    inherited?: boolean;
                    type: Method;
                    value: { class: string; generic: string };
                }[];
                name?: { inherited?: boolean; type: Name; value: string }[];
                noMd?: { inherited?: boolean; type: NoMd }[];
                noRd?: { inherited?: boolean; type: NoRd }[];
                order?: { inherited?: boolean; type: Order; value: number | undefined }[];
                param?: {
                    inherited?: boolean;
                    type: Param;
                    value: { description: string; name: string };
                }[];
                rawNamespace?: { inherited?: boolean; type: RawNamespace; value: string }[];
                rawRd?: { inherited?: boolean; type: RawRd; value: string }[];
                rdname?: { inherited?: boolean; type: RdName; value: string }[];
                references?: { inherited?: boolean; type: References; value: string }[];
                return?: { inherited?: boolean; type: Return; value: string }[];
                returns?: { inherited?: boolean; type: Returns; value: string }[];
                section?: {
                    inherited?: boolean;
                    type: Section;
                    value: { content: string; title: string };
                }[];
                seealso?: { inherited?: boolean; type: SeeAlso; value: string[] }[];
                slot?: {
                    inherited?: boolean;
                    type: Slot;
                    value: { description: string; name: string };
                }[];
                source?: { inherited?: boolean; type: Source; value: string }[];
                template?: { inherited?: boolean; type: Template; value: string }[];
                templateVar?: {
                    inherited?: boolean;
                    type: TemplateVar;
                    value: { name: string; value: string };
                }[];
                text?: { inherited?: boolean; type: Text; value: string }[];
                title?: { inherited?: boolean; type: Title; value: string }[];
                unknown?: {
                    inherited?: boolean;
                    type: Unknown;
                    value: { content: string; tag: string };
                }[];
                usage?: { inherited?: boolean; type: Usage; value: string }[];
                useDynLib?: { inherited?: boolean; type: UseDynLib; value: string }[];
            };
            [key: string]: unknown;
        };
    }
    node: RNode<Info>