External module "types/ts-enum"

Index

Classes

TsEnumType

Interfaces

TsEnumTypeOptions

Type aliases

Variables

name

Functions

Type aliases

Diff

Diff: number

EnumObject

EnumObject<EO, E>: Record<keyof EO, E>

Type parameters

EO
E: number | string

Name

Name: "ts-enum"

TsEnum

TsEnum<EnumConstructor>: object

Represents an enum value defined in EnumConstructor

Type parameters

EnumConstructor

Type declaration

Variables

Const name

name: Name = "ts-enum"

Functions

getEnumMaps

getEnumMaps<K, E>(tsEnum: Record<K, E>, changeCase: CaseStyle | undefined, renameAll?: undefined | object): [Map<E, string>, Map<string, E>]

- Defined in types/ts-enum.ts:47
Converts a TS enum and rename options to two maps: from out names to values and from values to out names.

Type parameters
- K: string
- E: string | number
Parameters
- tsEnum: Record<K, E>
- changeCase: CaseStyle | undefined
- Optional renameAll: undefined | object
Returns [Map<E, string>, Map<string, E>]

isValidEnumMember

isValidEnumMember(key: string): boolean

- Defined in types/ts-enum.ts:39
Function used by TS to check the names of enums (isNumericLiteralName)

see

https://github.com/Microsoft/TypeScript/blob/89de4c9a3ab3f7f88a141f1529b77628204bff73/lib/tsc.js#L36877

Parameters
- key: string
Returns boolean

tsEnumToMap

tsEnumToMap<K, E>(tsEnum: Record<K, E>): Map<K, E>

- Defined in types/ts-enum.ts:23
Builds a map from a TS enum by removing reverse-lookup keys.

Type parameters
- K: string
- E: string | number
Parameters
- tsEnum: Record<K, E>
Returns Map<K, E>

Generated using TypeDoc