UnorderedSet
Last updated
Last updated
• Docs
/ / UnorderedSet
An unordered set that stores data in NEAR storage.
• DataType
new UnorderedSet<
DataType
>(prefix
): <DataType
>
Parameters
• prefix: string
The byte prefix to use when storing elements inside this collection.
Returns
<DataType
>
Defined in
Defined in
readonly
elementIndexPrefix:string
Defined in
readonly
prefix:string
The byte prefix to use when storing elements inside this collection.
Defined in
get
length():number
The number of elements stored in the collection.
Returns
number
Defined in
Returns
Defined in
clear(
options
?):void
Remove all of the elements stored within the collection.
Parameters
Returns
void
Defined in
contains(
element
,options
?):boolean
Checks whether the collection contains the value.
Parameters
• element: DataType
The value for which to check the presence.
Options for storing data.
Returns
boolean
Defined in
elements(
__namedParameters
):DataType
[]
Parameters
• __namedParameters
• __namedParameters.limit?: number
• __namedParameters.start?: number
Returns
DataType
[]
Defined in
extend(
elements
):void
Extends the current collection with the passed in array of elements.
Parameters
• elements: DataType
[]
The elements to extend the collection with.
Returns
void
Defined in
isEmpty():
boolean
Checks whether the collection is empty.
Returns
boolean
Defined in
remove(
element
,options
?):boolean
Returns true if the element was present in the set.
Parameters
• element: DataType
The entry to remove.
Options for retrieving and storing data.
Returns
boolean
Defined in
serialize(
options
?):Uint8Array
Serialize the collection.
Parameters
Options for storing the data.
Returns
Uint8Array
Defined in
set(
element
,options
?):boolean
If the set did not have this value present, true
is returned. If the set did have this value present, false
is returned.
Parameters
• element: DataType
The value to store in the collection.
Options for storing the data.
Returns
boolean
Defined in
toArray(
options
?):DataType
[]
Return a JavaScript array of the data stored within the collection.
Parameters
Options for retrieving and storing the data.
Returns
DataType
[]
Defined in
Converts the deserialized data from storage to a JavaScript instance of the collection.
Type Parameters
• DataType
Parameters
The deserialized data to create an instance from.
Returns
Defined in
readonly
_elements: <DataType
>
[iterator](): <DataType
>
<DataType
>
• options?: Pick
<<DataType
>, "serializer"
>
• options?: Pick
<<DataType
>, "serializer"
>
• __namedParameters.options?: <DataType
>
• options?: <DataType
>
• options?: Pick
<<DataType
>, "serializer"
>
• options?: Pick
<<DataType
>, "serializer"
>
• options?: <DataType
>
static
reconstruct<DataType
>(data
): <DataType
>
• data: <DataType
>
<DataType
>