mirror of
https://github.com/LiteyukiStudio/LiteyukiBot.git
synced 2025-07-28 15:00:56 +00:00
✨ 修正工作流
This commit is contained in:
113
docs/dev/api/comm/storage.md
Normal file
113
docs/dev/api/comm/storage.md
Normal file
@ -0,0 +1,113 @@
|
||||
---
|
||||
title: liteyuki.comm.storage
|
||||
order: 1
|
||||
icon: laptop-code
|
||||
category: API
|
||||
---
|
||||
|
||||
### ***def*** `set(self: Any, key: str, value: Any) -> None`
|
||||
|
||||
设置键值对
|
||||
Args:
|
||||
key: 键
|
||||
value: 值
|
||||
|
||||
### ***def*** `get(self: Any, key: str, default: Optional[Any]) -> Optional[Any]`
|
||||
|
||||
获取键值对
|
||||
Args:
|
||||
key: 键
|
||||
default: 默认值
|
||||
|
||||
Returns:
|
||||
Any: 值
|
||||
|
||||
### ***def*** `delete(self: Any, key: str, ignore_key_error: bool) -> None`
|
||||
|
||||
删除键值对
|
||||
Args:
|
||||
key: 键
|
||||
ignore_key_error: 是否忽略键不存在的错误
|
||||
|
||||
Returns:
|
||||
|
||||
### ***def*** `get_all(self: Any) -> dict[str, Any]`
|
||||
|
||||
获取所有键值对
|
||||
Returns:
|
||||
dict[str, Any]: 键值对
|
||||
|
||||
### ***def*** `get_instance(cls: Any) -> None`
|
||||
|
||||
|
||||
|
||||
### ***def*** `on_get(data: tuple[str, dict[str, Any]]) -> None`
|
||||
|
||||
|
||||
|
||||
### ***def*** `on_set(data: tuple[str, dict[str, Any]]) -> None`
|
||||
|
||||
|
||||
|
||||
### ***def*** `on_delete(data: tuple[str, dict[str, Any]]) -> None`
|
||||
|
||||
|
||||
|
||||
### ***def*** `on_get_all(data: tuple[str, dict[str, Any]]) -> None`
|
||||
|
||||
|
||||
|
||||
### ***class*** `KeyValueStore`
|
||||
|
||||
|
||||
|
||||
####   ***def*** `set(self: Any, key: str, value: Any) -> None`
|
||||
|
||||
设置键值对
|
||||
Args:
|
||||
key: 键
|
||||
value: 值
|
||||
|
||||
####   ***def*** `get(self: Any, key: str, default: Optional[Any]) -> Optional[Any]`
|
||||
|
||||
获取键值对
|
||||
Args:
|
||||
key: 键
|
||||
default: 默认值
|
||||
|
||||
Returns:
|
||||
Any: 值
|
||||
|
||||
####   ***def*** `delete(self: Any, key: str, ignore_key_error: bool) -> None`
|
||||
|
||||
删除键值对
|
||||
Args:
|
||||
key: 键
|
||||
ignore_key_error: 是否忽略键不存在的错误
|
||||
|
||||
Returns:
|
||||
|
||||
####   ***def*** `get_all(self: Any) -> dict[str, Any]`
|
||||
|
||||
获取所有键值对
|
||||
Returns:
|
||||
dict[str, Any]: 键值对
|
||||
|
||||
### ***class*** `GlobalKeyValueStore`
|
||||
|
||||
|
||||
|
||||
#### `@classmethod`
|
||||
|
||||
####   ***def*** `get_instance(cls: Any) -> None`
|
||||
|
||||
|
||||
|
||||
####   ***attr*** `_instance`
|
||||
|
||||
Type: None
|
||||
|
||||
####   ***attr*** `_lock`
|
||||
|
||||
Type: threading.Lock()
|
||||
|
Reference in New Issue
Block a user