Class BTreeSet<V>

Type Parameters

V extends Codec = Codec

Hierarchy

Set<V>
- BTreeSet

Implements

ISet<V>

Index

Constructors

constructor

new BTreeSet<V extends Codec = Codec>(
    registry: Registry,
    valType: string | CodecClass<V, any[]>,
    rawValue?: string | Uint8Array | string[] | Set<any>,
): BTreeSet<V>
Type Parameters
- V extends Codec = Codec
Parameters
- registry: Registry
- valType: string | CodecClass<V, any[]>
- OptionalrawValue: string | Uint8Array | string[] | Set<any>
Returns BTreeSet<V>
Overrides Set<V>.constructor
- Defined in packages/types-codec/src/extended/BTreeSet.ts:81

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/extended/BTreeSet.ts:102

hash

get hash(): IU8a
Returns IU8a

Description
Returns a hash of the value
Implementation of ISet.hash
- Defined in packages/types-codec/src/extended/BTreeSet.ts:115

isEmpty

get isEmpty(): boolean
Returns boolean

Description
Checks if the value is an empty value
Implementation of ISet.isEmpty
- Defined in packages/types-codec/src/extended/BTreeSet.ts:122

strings

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

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

Methods

[iterator]

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

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

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

add

add(value: V): this
Appends a new element with a specified value to the end of the Set.
Parameters
- value: V
Returns this
Implementation of ISet.add

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

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: V): boolean
Removes a specified value from the Set.
Parameters
- value: V
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<[V, V]>
Returns an iterable of [v,v] pairs for every value v in the set.

Returns IterableIterator<[V, V]>
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/extended/BTreeSet.ts:136

forEach

forEach(
callbackfn: (value: V, value2: V, set: Set<V>) => void,
thisArg?: any,
): void
Executes a provided function once per each value in the Set object, in insertion order.
Parameters
- callbackfn: (value: V, value2: V, set: Set<V>) => 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: V): boolean
Parameters
- value: V
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/extended/BTreeSet.ts:143

keys

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

Returns IterableIterator<V>
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. isLe returns a LE (number-only) representation
Implementation of ISet.toHex
- Defined in packages/types-codec/src/extended/BTreeSet.ts:159

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 ISet.toHuman
- Defined in packages/types-codec/src/extended/BTreeSet.ts:166

toJSON

toJSON(): AnyJson
Returns AnyJson

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

toPrimitive

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

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

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/extended/BTreeSet.ts:192

toString

toString(): string
Returns string

Description
Returns the string representation of the value
Implementation of ISet.toString
- Defined in packages/types-codec/src/extended/BTreeSet.ts:212

toU8a

toU8a(isBare?: boolean): Uint8Array
Parameters
- OptionalisBare: boolean
  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 ISet.toU8a
- Defined in packages/types-codec/src/extended/BTreeSet.ts:220

values

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

Returns IterableIterator<V>
Implementation of ISet.values

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

`Static`with

with<V extends Codec>(
valType: string | CodecClass<V, any[]>,
): CodecClass<BTreeSet<V>>
Type Parameters
- V extends Codec
Parameters
- valType: string | CodecClass<V, any[]>
Returns CodecClass<BTreeSet<V>>
- Defined in packages/types-codec/src/extended/BTreeSet.ts:91

Class BTreeSet<V>

Type Parameters

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BTreeSet<V>

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

Methods

[iterator]

Returns IterableIterator<V>

add

Parameters

Returns this

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns IterableIterator<[V, V]>

eq

Parameters

Returns boolean

Description

forEach

Parameters

Returns void

has

Parameters

Returns boolean

inspect

Returns Inspect

Description

keys

Returns IterableIterator<V>

toHex

Returns `0x${string}`

Description

toHuman

Parameters

Returns AnyJson

Description

toJSON

Returns AnyJson

Description

toPrimitive

Parameters

`Readonly`[toStringTag]

`Optional`createdAtHash

`Optional`initialU8aLength

`Optional`isStorageFallback

`Readonly`registry

`Readonly`size

`Static` `Readonly`[species]

`Static`with