Function filterToEnumValues

  • filterToEnumValues<const T extends EnumBaseType>(
        inputs: readonly unknown[],
        checkEnum: T,
    ): T[keyof T][]

  • Filters the input array to all valid values from the given enum.

    Type Parameters

    Parameters

    • inputs: readonly unknown[]
    • checkEnum: T

    Returns T[keyof T][]

    A new array (does not mutate).

    Example

    enum MyEnum {
        A = 'a',
        B = 'b',
    }

    const result = filterToEnumValues([1, 2, 3, 'a', 'b', MyEnum.A], MyEnum); // result is `[MyEnum.A, MyEnum.B, MyEnum.A]`

    Package

    @augment-vir/common

Settings

Member Visibility