Interface IgnoreOfMap

Augmentable map of method/property names to exclude from KeyOf/ValueOf/OwnOf

interface IgnoreOfMap {
    "[iterator]": () => IterableIterator<EntryOf<any>>;
    "[toStringTag]": "Enumify";
    count(): number;
    entries(): EntryOf<any>[];
    extend<const E extends any[] | Property<any>>(
        list: E,
        frozen?: boolean,
    ): EnumifyType<any>;
    filter(
        fn: (
            entry: EntryOf<any>,
            index: number,
            enumify: EnumifyType<any>,
        ) => boolean,
        thisArg?: any,
    ): EnumifyType<Partial<any>>;
    forEach(
        fn: (
            entry: EntryOf<any>,
            index: number,
            enumify: EnumifyType<any>,
        ) => void,
        thisArg?: any,
    ): void;
    has(key: LooseKey<string | number | symbol>): boolean;
    includes(search: any): boolean;
    invert(): Invert<T>;
    keyOf(search: any): string | number | symbol;
    keys(): (string | number | symbol)[];
    map(
        fn: (
            entry: EntryOf<any>,
            index: number,
            enumify: EnumifyType<any>,
        ) => any,
        thisArg?: any,
    ): EnumifyType<Property<any>>;
    values(): any[];
}

Hierarchy (View Summary)

EnumMethods
- IgnoreOfMap

Index

Properties

[iterator] [toStringTag]

Methods

count entries extend filter forEach has includes invert keyOf keys map values

Properties

`Readonly`[iterator]

"[iterator]": () => IterableIterator<EntryOf<any>>

iterate through all Enum entries

`Readonly`[toStringTag]

"[toStringTag]": "Enumify"

used to identify the Enumify type

Methods

count

count(): number
number of entries in the Enum

Returns number
Inherited from EnumMethods.count
- Defined in packages/library/src/common/enumerate.library.ts:19

entries

entries(): EntryOf<any>[]
tuple of enumerable entries

Returns EntryOf<any>[]
Inherited from EnumMethods.entries
- Defined in packages/library/src/common/enumerate.library.ts:22

extend

extend<const E extends any[] | Property<any>>(
list: E,
frozen?: boolean,
): EnumifyType<any>
extend an Enum with new entries
Type Parameters
- const E extends any[] | Property<any>
Parameters
- list: E
- Optionalfrozen: boolean
Returns EnumifyType<any>
Inherited from EnumMethods.extend
- Defined in packages/library/src/common/enumerate.library.ts:30

filter

filter(
    fn: (
        entry: EntryOf<any>,
        index: number,
        enumify: EnumifyType<any>,
    ) => boolean,
    thisArg?: any,
): EnumifyType<Partial<any>>
filter Enum entries and return a new Enum
Parameters
- fn: (entry: EntryOf<any>, index: number, enumify: EnumifyType<any>) => boolean
- OptionalthisArg: any
Returns EnumifyType<Partial<any>>
Inherited from EnumMethods.filter
- Defined in packages/library/src/common/enumerate.library.ts:28

forEach

forEach(
    fn: (
        entry: EntryOf<any>,
        index: number,
        enumify: EnumifyType<any>,
    ) => void,
    thisArg?: any,
): void
iterate through all Enum entries
Parameters
- fn: (entry: EntryOf<any>, index: number, enumify: EnumifyType<any>) => void
- OptionalthisArg: any
Returns void
Inherited from EnumMethods.forEach
- Defined in packages/library/src/common/enumerate.library.ts:27

has

has(key: LooseKey<string | number | symbol>): boolean
check if a 'key' exists in the Enum
Parameters
- key: LooseKey<string | number | symbol>
Returns boolean
Inherited from EnumMethods.has
- Defined in packages/library/src/common/enumerate.library.ts:24

includes

includes(search: any): boolean
check if a 'value' exists in the Enum
Parameters
- search: any
Returns boolean
Inherited from EnumMethods.includes
- Defined in packages/library/src/common/enumerate.library.ts:25

invert

invert(): Invert<T>
return an object with the keys and values swapped

Returns Invert<T>
Inherited from EnumMethods.invert
- Defined in packages/library/src/common/enumerate.library.ts:23

keyOf

keyOf(search: any): string | number | symbol
return the key for a given value
Parameters
- search: any
Returns string | number | symbol
Inherited from EnumMethods.keyOf
- Defined in packages/library/src/common/enumerate.library.ts:26

keys

keys(): (string | number | symbol)[]
array of all enumerable property names

Returns (string | number | symbol)[]
Inherited from EnumMethods.keys
- Defined in packages/library/src/common/enumerate.library.ts:20

map

map(
    fn: (
        entry: EntryOf<any>,
        index: number,
        enumify: EnumifyType<any>,
    ) => any,
    thisArg?: any,
): EnumifyType<Property<any>>
map Enum entries and return a new Enum
Parameters
- fn: (entry: EntryOf<any>, index: number, enumify: EnumifyType<any>) => any
- OptionalthisArg: any
Returns EnumifyType<Property<any>>
Inherited from EnumMethods.map
- Defined in packages/library/src/common/enumerate.library.ts:29

values

values(): any[]
array of all enumerable object values

Returns any[]
Inherited from EnumMethods.values
- Defined in packages/library/src/common/enumerate.library.ts:21

Interface IgnoreOfMap

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Readonly[iterator]

Readonly[toStringTag]

Methods

count

Returns number

entries

Returns EntryOf<any>[]

extend

Type Parameters

Parameters

Returns EnumifyType<any>

filter

Parameters

Returns EnumifyType<Partial<any>>

forEach

Parameters

Returns void

has

Parameters

Returns boolean

includes

Parameters

Returns boolean

invert

Returns Invert<T>

keyOf

Parameters

Returns string | number | symbol

keys

Returns (string | number | symbol)[]

map

Parameters

Returns EnumifyType<Property<any>>

values

Returns any[]

Settings

On This Page

`Readonly`[iterator]

`Readonly`[toStringTag]