name: EnumType

description: This implements an enum, that based on the value wraps a different type. It is effectively an extension to enum where the value type is determined by the actual index.

# Type parameters

# T

# Hierarchy

Base<Codec>

↳ EnumType

↳ StorageFunctionType

↳ MetadataStorageModifier

↳ MetadataStorageType

↳ ValidityAttestation

↳ DigestItem

↳ Phase

↳ ExtrinsicStatus

↳ MisbehaviorKind

# Implements

• Codec

# Constructors

# constructor

⊕ new EnumType(def: TypesDef, value?: any, index?: number | EnumType<T>): EnumType

Overrides Base.constructor

Defined in codec/EnumType.ts:35

Parameters:

Name	Type
def	TypesDef
Optional value	any
Optional index	number | EnumType<T>

Returns: EnumType

---

# Accessors

# encodedLength

get encodedLength(): number

Defined in codec/EnumType.ts:114

description: The length of the value when encoded as a Uint8Array

Returns: number

---

# index

get index(): number

Defined in codec/EnumType.ts:121

description: The index of the metadata value

Returns: number

---

# isEmpty

get isEmpty(): boolean

Defined in codec/EnumType.ts:128

description: Checks if the value is an empty value

Returns: boolean

---

# isNone

get isNone(): boolean

Defined in codec/EnumType.ts:135

description: Checks if the Enum points to a Null type

Returns: boolean

---

# isNull

get isNull(): boolean

Defined in codec/EnumType.ts:142

description: Checks if the Enum points to a Null type (deprecated, use isNone)

Returns: boolean

---

# type

get type(): string

Defined in codec/EnumType.ts:149

description: The name of the type this enum value represents

Returns: string

---

# value

get value(): Codec

Defined in codec/EnumType.ts:156

description: The value of the enum

Returns: Codec

---

# Methods

# eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Defined in codec/EnumType.ts:163

description: Compares the value of the input to see if there is a match

Parameters:

Name	Type
Optional other	any

Returns: boolean

---

# toHex

▸ toHex(): string

Implementation of Codec.toHex

Defined in codec/EnumType.ts:176

description: Returns a hex string representation of the value

Returns: string

---

# toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Defined in codec/EnumType.ts:183

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

---

# toNumber

▸ toNumber(): number

Defined in codec/EnumType.ts:192

description: Returns the number representation for the value

Returns: number

---

# toString

▸ toString(): string

Implementation of Codec.toString

Defined in codec/EnumType.ts:199

description: Returns the string representation of the value

Returns: string

---

# toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Defined in codec/EnumType.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name	Type	Description
Optional isBare	undefined | false | true	true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

---

# <Static> with

▸ with<S>(Types: S): EnumConstructor<EnumType<S>>

Defined in codec/EnumType.ts:101

Type parameters:

# S : ConstructorDef

Parameters:

Name	Type
Types	S

Returns: EnumConstructor<EnumType<S>>

---