docs: baked a lot of API docs
This commit is contained in:
+55
-1
@@ -7,4 +7,58 @@ references:
|
||||
|
||||
The Client Store API provides a simple key-value store for client-specific states and preferences.
|
||||
|
||||
${spacelua.renderApiDocumentation("clientStore")}
|
||||
<!--#lua spacelua.renderApiDocumentation("clientStore") -->
|
||||
## clientStore.delete
|
||||
|
||||
`clientStore.delete(key)`
|
||||
|
||||
Deletes a client-specific value from the local key-value store.
|
||||
|
||||
**Parameters:**
|
||||
|
||||
- `key` (`string`) — Key to delete.
|
||||
|
||||
**Example:**
|
||||
|
||||
```lua
|
||||
clientStore.delete("theme")
|
||||
```
|
||||
|
||||
## clientStore.get
|
||||
|
||||
`clientStore.get(key)`
|
||||
|
||||
Gets a client-specific value from the local key-value store.
|
||||
|
||||
**Parameters:**
|
||||
|
||||
- `key` (`string`) — Key to read.
|
||||
|
||||
**Returns:**
|
||||
|
||||
- Value — Stored value, or nil when absent.
|
||||
|
||||
**Example:**
|
||||
|
||||
```lua
|
||||
local theme = clientStore.get("theme")
|
||||
```
|
||||
|
||||
## clientStore.set
|
||||
|
||||
`clientStore.set(key, value)`
|
||||
|
||||
Stores a client-specific value in the local key-value store.
|
||||
|
||||
**Parameters:**
|
||||
|
||||
- `key` (`string`) — Key to set.
|
||||
- `value` — Value to store.
|
||||
|
||||
**Example:**
|
||||
|
||||
```lua
|
||||
clientStore.set("theme", "dark")
|
||||
```
|
||||
<!--/lua-->
|
||||
|
||||
|
||||
Reference in New Issue
Block a user