Class AbstractBase<T>`Abstract`

Name

Base

Description

A type extends the Base class, when it holds a value

Type Parameters

T extends Codec

Hierarchy (View Summary)

AbstractBase

Implements

Codec

Index

Constructors

`Protected`constructor

new AbstractBase<T extends Codec>(
    registry: Registry,
    value: T,
    initialU8aLength?: number,
): AbstractBase<T>
Type Parameters
- T extends Codec
Parameters
- registry: Registry
- value: T
- OptionalinitialU8aLength: number
Returns AbstractBase<T>
- Defined in packages/types-codec/src/abstract/Base.ts:20

Properties

`Optional`createdAtHash

createdAtHash?: IU8a

Description

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

`Optional`initialU8aLength

initialU8aLength?: number

Description

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

`Optional`isStorageFallback

isStorageFallback?: boolean

Description

(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)

`Readonly`registry

registry: Registry

Description

The registry associated with this object

Accessors

encodedLength

get encodedLength(): number
Returns number

Description
The length of the value when encoded as a Uint8Array
Implementation of Codec.encodedLength
- Defined in packages/types-codec/src/abstract/Base.ts:29

hash

get hash(): IU8a
Returns IU8a

Description
returns a hash of the contents
Implementation of Codec.hash
- Defined in packages/types-codec/src/abstract/Base.ts:36

inner

get inner(): T
Returns T

Description
returns the inner (wrapped value)
- Defined in packages/types-codec/src/abstract/Base.ts:43

isEmpty

get isEmpty(): boolean
Returns boolean

Description
Checks if the value is an empty value
Implementation of Codec.isEmpty
- Defined in packages/types-codec/src/abstract/Base.ts:50

Methods

eq

eq(other?: unknown): boolean
Parameters
- Optionalother: unknown
Returns boolean

Description
Compares the value of the input to see if there is a match
Implementation of Codec.eq
- Defined in packages/types-codec/src/abstract/Base.ts:57

inspect

inspect(): Inspect
Returns Inspect

Description
Returns a breakdown of the hex encoding for this Codec
Implementation of Codec.inspect
- Defined in packages/types-codec/src/abstract/Base.ts:64

toHex

toHex(isLe?: boolean): `0x${string}`
Parameters
- OptionalisLe: boolean
Returns `0x${string}`

Description
Returns a hex string representation of the value. isLe returns a LE (number-only) representation
Implementation of Codec.toHex
- Defined in packages/types-codec/src/abstract/Base.ts:71

toHuman

toHuman(isExtended?: boolean, disableAscii?: boolean): AnyJson
Parameters
- OptionalisExtended: boolean
- OptionaldisableAscii: boolean
Returns AnyJson

Description
Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
Implementation of Codec.toHuman
- Defined in packages/types-codec/src/abstract/Base.ts:78

toJSON

toJSON(): AnyJson
Returns AnyJson

Description
Converts the Object to JSON, typically used for RPC transfers
Implementation of Codec.toJSON
- Defined in packages/types-codec/src/abstract/Base.ts:85

toPrimitive

toPrimitive(disableAscii?: boolean): AnyJson
Parameters
- OptionaldisableAscii: boolean
Returns AnyJson

Description
Converts the value in a best-fit primitive form
Implementation of Codec.toPrimitive
- Defined in packages/types-codec/src/abstract/Base.ts:92

`Abstract`toRawType

toRawType(): string
Returns string

Description
Returns the base runtime type name for this instance
Implementation of Codec.toRawType
- Defined in packages/types-codec/src/abstract/Base.ts:114

toString

toString(): string
Returns string

Description
Returns the string representation of the value
Implementation of Codec.toString
- Defined in packages/types-codec/src/abstract/Base.ts:99

toU8a

toU8a(isBare?: BareOpts): Uint8Array
Parameters
- OptionalisBare: BareOpts
  true when the value has none of the type-specific prefixes (internal)
Returns Uint8Array

Description
Encodes the value as a Uint8Array as per the SCALE specifications
Implementation of Codec.toU8a
- Defined in packages/types-codec/src/abstract/Base.ts:107

unwrap

unwrap(): T
Returns T

Description
Returns the inner wrapped value (equivalent to valueOf)
- Defined in packages/types-codec/src/abstract/Base.ts:119

valueOf

valueOf(): T
Returns T

Description
Returns the inner wrapped value
- Defined in packages/types-codec/src/abstract/Base.ts:126

Class AbstractBase<T>Abstract

Name

Description

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns AbstractBase<T>

Properties

OptionalcreatedAtHash

Description

OptionalinitialU8aLength

Description

OptionalisStorageFallback

Description

Readonlyregistry

Description

Accessors

encodedLength

Returns number

Description

hash

Returns IU8a

Description

inner

Returns T

Description

isEmpty

Returns boolean

Description

Methods

eq

Parameters

Returns boolean

Description

inspect

Returns Inspect

Description

toHex

Parameters

Returns `0x${string}`

Description

toHuman

Parameters

Returns AnyJson

Description

toJSON

Returns AnyJson

Description

toPrimitive

Parameters

Returns AnyJson

Description

AbstracttoRawType

Returns string

Description

toString

Returns string

Description

toU8a

Parameters

Returns Uint8Array

Description

unwrap

Returns T

Description

valueOf

Returns T

Description

Settings

On This Page

Class AbstractBase<T>`Abstract`

`Protected`constructor

`Optional`createdAtHash

`Optional`initialU8aLength

`Optional`isStorageFallback

`Readonly`registry

`Abstract`toRawType