Skip to content

Decrement Score

Description

This operation decrements the score of an item by the specified number.

Method

Backendless.Hive( hiveName ).SortedSetStore( keyName ).decrementScore( value, scoreValue ): Promise<number>;

where:

Argument                Description
hiveName Name of a hive in the system where the operation is performed. Must be a string.
keyName Key name of a sorted set where a score is decremented. Must be a string.
value An exact value as one already in the sorted set. The value identifies a score/value pair. The score of the corresponding value in the sorted set will be decremented by the number in the scoreValue parameter. The value can be of any valid JS data type.
scoreValue A number that the existing score will be decremented by. Must be a double value.

Return Value

The decremented score of an item.

Example

The example below decrements the score associated with the value "John" by 3.

await Backendless.Hive('leaderboard').SortedSetStore('players').decrementScore('John', 3)

where:

Argument                Description
'leaderboard' Name of a hive in the system.
'players' Name of a sorted set where to decrement the score of an item


Codeless Reference

sorted_set_api_decrement_score

where:

Argument                Description
hive name Name of a hive where the operation is performed.
key name Key name identifying a sorted set.
value An exact value as one already in the sorted set. The value identifies a score/value pair. The score of the corresponding value in the sorted set will be decremented by the number in the decrement by parameter.
decrement by Specify the number to decrement the score of the value.

The operation returns the decremented score of the item.

Consider the following Sorted Set storage:
sorted_set_api_example_all_blocks

The example below decrements the score of a value "John" by 3:
sorted_set_api_example_decrement_score


The output will look as shown below after the Codeless logic runs.
sorted_set_api_example_decrement_score_2
Note how the decremented score forced the score/value pair to change its current position(rank). Before the operation the rank of the "John" value was 1, and after the operation the rank became 0.

Rank in a sorted set determines the position of an element. For more information about the rank, refer to the Hive Overview section of this guide.