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

    Interface EnrichmentData<ElementContent, ElementArguments, SearchContent, SearchArguments>

    interface EnrichmentData<
        ElementContent extends MergeableRecord,
        ElementArguments = undefined,
        SearchContent extends MergeableRecord = never,
        SearchArguments = ElementArguments,
    > {
        enrichElement?: (
            element: FlowrSearchElement<ParentInformation>,
            search: FlowrSearchElements<ParentInformation>,
            analyzer: ReadonlyFlowrAnalysisProvider,
            args: ElementArguments | undefined,
            previousValue: ElementContent | undefined,
        ) => AsyncOrSync<ElementContent>;
        enrichSearch?: (
            search: FlowrSearchElements<ParentInformation>,
            data: ReadonlyFlowrAnalysisProvider,
            args: SearchArguments | undefined,
            previousValue: SearchContent | undefined,
        ) => AsyncOrSync<SearchContent>;
        mapper?: (
            content: ElementContent,
        ) => FlowrSearchElement<ParentInformation>[];
    }

    Type Parameters

    Index

    Properties

    enrichElement?: (
        element: FlowrSearchElement<ParentInformation>,
        search: FlowrSearchElements<ParentInformation>,
        analyzer: ReadonlyFlowrAnalysisProvider,
        args: ElementArguments | undefined,
        previousValue: ElementContent | undefined,
    ) => AsyncOrSync<ElementContent>

    A function that is applied to each element of the search to enrich it with additional data.

    enrichSearch?: (
        search: FlowrSearchElements<ParentInformation>,
        data: ReadonlyFlowrAnalysisProvider,
        args: SearchArguments | undefined,
        previousValue: SearchContent | undefined,
    ) => AsyncOrSync<SearchContent>

    The mapping function used by the Mapper.Enrichment mapper.