API Reference
This directory contains the API reference documentation for the ErisPulse framework.
Documentation List
| Documentation |
Description |
| Core Module API |
Quick reference for Storage, Config, Logger, Adapter, Module, Lifecycle, Router, and HTTP Client APIs |
| Event System API |
API reference for Command, Message, Notice, Request, and Meta event modules |
| Adapter System API |
API reference for Adapter Manager, SendDSL, Middleware, and Bot state management |
| Auto-generated API |
Complete API documentation automatically generated from source code docstrings |
Manually written API documentation focuses on usage examples and quick reference; auto-generated API documentation includes complete class/method signatures. The two complement each other.
Module Overview
Core Modules
| Module |
Access Path |
Description |
sdk.storage |
sdk.storage |
Key-value storage based on SQLite + SQL chain query |
sdk.config |
sdk.config |
Configuration management in TOML format |
sdk.logger |
sdk.logger |
Modular logging system, supports sub-loggers |
sdk.adapter |
sdk.adapter |
Multi-platform adapter management |
sdk.module |
sdk.module |
Module registration, loading, and unloading management |
sdk.lifecycle |
sdk.lifecycle |
Lifecycle event management |
sdk.router |
sdk.router |
HTTP/WebSocket routing management |
sdk.client |
sdk.client |
Unified HTTP/WS client |
Event System
| Module |
Import Path |
Description |
command |
ErisPulse.Core.Event.command |
Command handling (prefix parsing, aliases) |
message |
ErisPulse.Core.Event.message |
Message events (private chat, group chat, @ messages) |
notice |
ErisPulse.Core.Event.notice |
Notice events (friend, group member changes) |
request |
ErisPulse.Core.Event.request |
Request events (friend requests, group invitations) |
meta |
ErisPulse.Core.Event.meta |
Meta events (connection, disconnection, heartbeat) |
Base Classes
| Base Class |
Import Path |
Description |
BaseModule |
ErisPulse.Core.Bases.module.BaseModule |
Module base class (on_load/on_unload) |
BaseAdapter |
ErisPulse.Core.Bases.adapter.BaseAdapter |
Adapter base class (start/shutdown/call_api) |