Dependicus API Reference
    Preparing search index...

    Interface GroupingConfig

    interface GroupingConfig {
        ecosystems?: readonly string[];
        getSections?: (context: GroupingDetailContext) => GroupingSection[];
        getValue: (
            name: string,
            store: FactStore,
        ) => string | readonly string[] | undefined;
        key: string;
        label: string;
        slugPrefix?: string;
    }
    Index

    Properties

    ecosystems? getSections? getValue key label slugPrefix?

    Properties

    ecosystems?: readonly string[]

    Ecosystems this grouping applies to, e.g. ['npm']. Providers for any other ecosystem skip it, and their pages leave it out of the nav. Omitted means every ecosystem.

    getSections?: (context: GroupingDetailContext) => GroupingSection[]

    Return sections to display on this grouping's detail pages.

    getValue: (
        name: string,
        store: FactStore,
    ) => string | readonly string[] | undefined

    Extract the grouping value, or values, for a dependency. Returns undefined to exclude it.

    Returning several values files the dependency under each of them, for a dimension whose membership overlaps: a package used by three teams belongs on all three of their pages.

    key: string
    label: string
    slugPrefix?: string

    Settings

    Member Visibility

    On This Page

    Properties