Class EdmEnum

classdesc: Edm enum

Hierarchy

Enum
- EdmEnum

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new EdmEnum(options: EdmEnumOptions): EdmEnum

Overrides core.Enum.constructor
- Defined in src/models/edm-enum.ts:95
Creates an instance of edm enum.

Parameters
- options: EdmEnumOptions
  
  The initialization options for the enum.
Returns EdmEnum

Properties

Private _symbolPrototype

_symbolPrototype: EnumSymbol

Private defaultValue

defaultValue: EdmEnumMember

Readonly isFlags

isFlags: boolean

True if this is a flags enum, false otherwise.

Private members

members: EdmEnumMember[] = []

Readonly name

name: string

The enum name.

Private Readonly underlyingDataType

underlyingDataType: DataTypeSymbol

validatorCtor

validatorCtor: () => Validator = Validator.none

Type declaration

- (): Validator
- Always returns true
  
  Returns Validator

Methods

addSymbol

addSymbol(enumMember?: Partial<EdmEnumMember>): EnumSymbol

Overrides core.Enum.addSymbol
- Defined in src/models/edm-enum.ts:108
Adds symbol to the enum.

Parameters
- Optional enumMember: Partial<EdmEnumMember>
Returns EnumSymbol
The breeze symbol for the enum member.

Private createEdmEnumMember

createEdmEnumMember(): EdmEnumMember

- Defined in src/models/edm-enum.ts:233
Returns EdmEnumMember

Private fromFlagsEnumName

fromFlagsEnumName(name: string): EnumSymbol

- Defined in src/models/edm-enum.ts:214
Parameters
- name: string
Returns EnumSymbol

Private fromFlagsEnumValue

fromFlagsEnumValue(value: number): EnumSymbol

- Defined in src/models/edm-enum.ts:195
Parameters
- value: number
Returns EnumSymbol

fromName

fromName(name: string): EnumSymbol

Overrides core.Enum.fromName
- Defined in src/models/edm-enum.ts:148
Gets the enum member from the specified name.

Parameters
- name: string
  
  The name.
Returns EnumSymbol
The enum symbol.

fromValue

fromValue(value: number): EnumSymbol

- Defined in src/models/edm-enum.ts:131
Gets the enum member from the specified value.

Parameters
- value: number
  
  The value.
Returns EnumSymbol
The enum symbol.

parse

parse(val: any, sourceTypeName?: string): any

- Defined in src/models/edm-enum.ts:166
Parses the value into the corresponding enum symbol.

Parameters
- val: any
- Optional sourceTypeName: string
Returns any
The enum symbol.

parseRawValue

parseRawValue(val: any): any

- Defined in src/models/edm-enum.ts:191
Parses the raw value into the corresponding enum symbol.

Parameters
- val: any
Returns any
The enum symbol.

Generated using TypeDoc