Are you an LLM? You can read better optimized documentation at /en/message-templates/types/storage/guild-index-entry.md for this page in Markdown format
GuildIndexEntry
This data type describes a specific index entry.
INFO
For more information about guild indexes and how to use them, check Guild Indexes article.
Properties
| Property | Type | Description |
|---|---|---|
key | String | Entry key |
value | Number | Entry value |
metadata | String | Entry metadata |
indexName | String | The index name related to this entry |
updatedAt | DateTime | Update date and time |
Methods
update(Value, Metadata)
Updates entry value.
Returns the same value.
Returns: Number
Warning! Quota
You can only update entry value once using any method.
increment(Number)
Increments the value by specified amount and returns new value.
Returns: Number
Warning! Quota
You can only update entry value once using any method.
decrement(Number)
Decrements the value by specified amount and returns new value.
Returns: Number
Warning! Quota
You can only update entry value once using any method.
clear()
Clears entry and deletes it from database.
Warning! Quota
You can only update entry value once using any method.