GetOptions
types/collections • Docs
near-sdk-js v2.0.0 / types/collections / GetOptions
Interface: GetOptions<DataType>
Options for retrieving and storing data in the SDK collections.
Type Parameters
• DataType
Properties
defaultValue?
optionaldefaultValue:DataType
A default value to return if the original value is not present or null.
Defined in
packages/near-sdk-js/src/types/collections.ts:14
Methods
deserializer()?
optionaldeserializer(valueToDeserialize):unknown
A deserializer function to customize the deserialization of values after reading from NEAR storage for this call.
Parameters
• valueToDeserialize: Uint8Array
The Uint8Array retrieved from NEAR storage to deserialize.
Returns
unknown
Defined in
packages/near-sdk-js/src/types/collections.ts:26
reconstructor()?
optionalreconstructor(value):DataType
A constructor function to call after deserializing a value. Typically this is a constructor of the class you are storing.
Parameters
• value: unknown
The value returned from deserialization - either the provided deserializer or default deserialization function.
Returns
DataType
Defined in
packages/near-sdk-js/src/types/collections.ts:10
serializer()?
optionalserializer(valueToSerialize):Uint8Array
A serializer function to customize the serialization of the collection for this call.
Parameters
• valueToSerialize: unknown
The value that will be serialized - either the DataType or a unknown value.
Returns
Uint8Array
Defined in
Last updated