Class CodecSet

Name

Set

Description

An Set is an array of string values, represented an an encoded type by a bitwise representation of the values.

Hierarchy

Set<string>
- CodecSet

Implements

ISet<string>

Index

Constructors

constructor

new CodecSet(
    registry: Registry,
    setValues: SetValues,
    value?: string | number | Uint8Array | string[] | BN | Set<string>,
    bitLength?: number,
): CodecSet
Parameters
- registry: Registry
- setValues: SetValues
- Optionalvalue: string | number | Uint8Array | string[] | BN | Set<string>
- bitLength: number = 8
Returns CodecSet
Overrides Set<string>.constructor
- Defined in packages/types-codec/src/native/Set.ts:105

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`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

`Readonly`size

size: number

Returns

the number of (unique) elements in Set.

`Static` `Readonly`[species]

"[species]": SetConstructor

Accessors

encodedLength

get encodedLength(): number
Returns number

Description
The length of the value when encoded as a Uint8Array
Implementation of ISet.encodedLength
- Defined in packages/types-codec/src/native/Set.ts:138

hash

get hash(): IU8a
Returns IU8a

Description
returns a hash of the contents
Implementation of ISet.hash
- Defined in packages/types-codec/src/native/Set.ts:145

isEmpty

get isEmpty(): boolean
Returns boolean

Description
true is the Set contains no values
Implementation of ISet.isEmpty
- Defined in packages/types-codec/src/native/Set.ts:152

strings

get strings(): string[]
Returns string[]

Description
The actual set values as a string[]
Implementation of ISet.strings
- Defined in packages/types-codec/src/native/Set.ts:159

valueEncoded

get valueEncoded(): BN
Returns BN

Description
The encoded value for the set members
- Defined in packages/types-codec/src/native/Set.ts:166

Methods

[iterator]

"[iterator]"(): IterableIterator<string>
Iterates over values in the set.

Returns IterableIterator<string>
Implementation of ISet.[iterator]

Inherited from Set.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:170

add

add(key: string): this
Parameters
- key: string
Returns this

Description
adds a value to the Set (extended to allow for validity checking)
Implementation of ISet.add

Overrides Set.add
- Defined in packages/types-codec/src/native/Set.ts:173

clear

clear(): void
Returns void
Implementation of ISet.clear

Inherited from Set.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:95

delete

delete(value: string): boolean
Removes a specified value from the Set.
Parameters
- value: string
Returns boolean
Returns true if an element in the Set existed and has been removed, or false if the element does not exist.
Implementation of ISet.delete

Inherited from Set.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:100

entries

entries(): IterableIterator<[string, string]>
Returns an iterable of [v,v] pairs for every value v in the set.

Returns IterableIterator<[string, string]>
Implementation of ISet.entries

Inherited from Set.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:174

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 ISet.eq
- Defined in packages/types-codec/src/native/Set.ts:189

forEach

forEach(
callbackfn: (value: string, value2: string, set: Set<string>) => void,
thisArg?: any,
): void
Executes a provided function once per each value in the Set object, in insertion order.
Parameters
- callbackfn: (value: string, value2: string, set: Set<string>) => void
- OptionalthisArg: any
Returns void
Implementation of ISet.forEach

Inherited from Set.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:104

has

has(value: string): boolean
Parameters
- value: string
Returns boolean
a boolean indicating whether an element with the specified value exists in the Set or not.
Implementation of ISet.has

Inherited from Set.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:108

inspect

inspect(): Inspect
Returns Inspect

Description
Returns a breakdown of the hex encoding for this Codec
Implementation of ISet.inspect
- Defined in packages/types-codec/src/native/Set.ts:205

keys

keys(): IterableIterator<string>
Despite its name, returns an iterable of the values in the set.

Returns IterableIterator<string>
Implementation of ISet.keys

Inherited from Set.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:178

toHex

toHex(): `0x${string}`
Returns `0x${string}`

Description
Returns a hex string representation of the value
Implementation of ISet.toHex
- Defined in packages/types-codec/src/native/Set.ts:214

toHuman

toHuman(): string[]
Returns string[]

Description
Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
Implementation of ISet.toHuman
- Defined in packages/types-codec/src/native/Set.ts:221

toJSON

toJSON(): string[]
Returns string[]

Description
Converts the Object to JSON, typically used for RPC transfers
Implementation of ISet.toJSON
- Defined in packages/types-codec/src/native/Set.ts:228

toNumber

toNumber(): number
Returns number

Description
The encoded value for the set members
- Defined in packages/types-codec/src/native/Set.ts:235

toPrimitive

toPrimitive(): string[]
Returns string[]

Description
Converts the value in a best-fit primitive form
Implementation of ISet.toPrimitive
- Defined in packages/types-codec/src/native/Set.ts:242

toRawType

toRawType(): string
Returns string

Description
Returns the base runtime type name for this instance
Implementation of ISet.toRawType
- Defined in packages/types-codec/src/native/Set.ts:249

toString

toString(): string
Returns string

Description
Returns the string representation of the value
Implementation of ISet.toString
- Defined in packages/types-codec/src/native/Set.ts:256

toU8a

toU8a(_isBare?: boolean): Uint8Array
Parameters
- Optional_isBare: boolean
Returns Uint8Array

Description
Encodes the value as a Uint8Array as per the SCALE specifications
Implementation of ISet.toU8a
- Defined in packages/types-codec/src/native/Set.ts:263

values

values(): IterableIterator<string>
Returns an iterable of values in the set.

Returns IterableIterator<string>
Implementation of ISet.values

Inherited from Set.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:183

`Static`with

with(values: SetValues, bitLength?: number): CodecClass<CodecSet>
Parameters
- values: SetValues
- OptionalbitLength: number
Returns CodecClass<CodecSet>
- Defined in packages/types-codec/src/native/Set.ts:113

Class CodecSet

Name

Description

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CodecSet

Properties

Readonly[toStringTag]

OptionalcreatedAtHash

Description

OptionalinitialU8aLength

Description

OptionalisStorageFallback

Description

Readonlyregistry

Description

Readonlysize

Returns

Static Readonly[species]

Accessors

encodedLength

Returns number

Description

hash

Returns IU8a

Description

isEmpty

Returns boolean

Description

strings

Returns string[]

Description

valueEncoded

Returns BN

Description

Methods

[iterator]

Returns IterableIterator<string>

add

Parameters

Returns this

Description

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns IterableIterator<[string, string]>

eq

Parameters

Returns boolean

Description

forEach

Parameters

Returns void

has

Parameters

Returns boolean

inspect

Returns Inspect

Description

keys

Returns IterableIterator<string>

toHex

Returns `0x${string}`

Description

toHuman

Returns string[]

Description

toJSON

Returns string[]

`Readonly`[toStringTag]

`Optional`createdAtHash

`Optional`initialU8aLength

`Optional`isStorageFallback

`Readonly`registry

`Readonly`size

`Static` `Readonly`[species]

`Static`with