Function filterValidNames

  • filterValidNames(
        colnames: undefined | (undefined | string)[],
        checkNames?: boolean,
        noDupNames?: boolean,
        noEmptyNames?: boolean,
        collapseDups?: boolean,
    ): undefined | (undefined | string)[]

    Maps all invalid, duplicate, or empty column names to top depending on the provided arguments.

    Parameters

    • colnames: undefined | (undefined | string)[]

      The columns names to filter

    • OptionalcheckNames: boolean

      Whether to map all invalid column names to top (undefined)

    • OptionalnoDupNames: boolean

      Whether to map all duplicate column names to top (undefined)

    • OptionalnoEmptyNames: boolean

      Whether to map all empty column names to top (undefined)

    • collapseDups: boolean = false

      Whether duplicate columns should be collapsed to single occurrences afterward (excluding undefined values)

    Returns undefined | (undefined | string)[]

    The filtered column names

Settings

Member Visibility