Pezkuwi API
    Preparing search index...

    Class Enum

    Enum

    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.

    Hierarchy (View Summary)

    Implements

    • IEnum
    Index
    constructor
    createdAtHash? initialU8aLength? isStorageFallback? registry
    defIndexes defKeys encodedLength hash index inner isBasic isEmpty isNone type value
    _toRawStruct eq inspect toHex toHuman toJSON toNumber toPrimitive toRawType toString toU8a with

    • Parameters

      • registry: Registry
      • Types:
            | string[]
            | Record<string, string | CodecClass<Codec, any[]>>
            | Record<string, number>
      • Optionalvalue: unknown
      • Optionalindex: number
      • __namedParameters: DefinitionSetter<Definition> = {}

      Returns Enum

    createdAtHash?: IU8a

    The block at which this value was retrieved/created (set to non-empty when retrieved from storage)

    initialU8aLength?: number

    The length of the initial encoded value (Only available when the value was constructed from a Uint8Array input)

    isStorageFallback?: boolean

    (internal usage) Indicates that the value was created via a fallback. This is used when with data specified in the metadata when the storage entry is empty.

    With metadata fallback values (available as defaults on most storage entries) any empty storage item should erturn the default. (This is the same as the implementation on the Bizinikiwi runtime)

    registry: Registry

    The registry associated with this object

    Protected_toRawStruct

    • _toRawStruct(): string[] | Record<string, string | number>

      Returns string[] | Record<string, string | number>

      Returns a raw struct representation of the enum types

    • Parameters

      • Optionalother: unknown

      Returns boolean

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

    • Parameters

      • OptionalisExtended: boolean
      • OptionaldisableAscii: boolean

      Returns AnyJson

      Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information

    • Parameters

      • OptionaldisableAscii: boolean

      Returns AnyJson

      Converts the value in a best-fit primitive form

    • Parameters

      • OptionalisBare: boolean

        true when the value has none of the type-specific prefixes (internal)

      Returns Uint8Array

      Encodes the value as a Uint8Array as per the SCALE specifications

    • Parameters

      • Types:
            | string[]
            | Record<string, string | CodecClass<Codec, any[]>>
            | Record<string, number>

      Returns EnumCodecClass<Enum>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods