From 5459d1c5ff285ca131375024fff913465e0c0a19 Mon Sep 17 00:00:00 2001
From: crazywhalecc <jesse2061@outlook.com>
Date: Tue, 14 Jun 2022 13:30:35 +0800
Subject: [PATCH] add @OnSave annotation docs

---
 docs/event/framework-annotations.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/docs/event/framework-annotations.md b/docs/event/framework-annotations.md
index a765834a..cf86b8de 100644
--- a/docs/event/framework-annotations.md
+++ b/docs/event/framework-annotations.md
@@ -262,6 +262,22 @@
 
 无。
 
+## OnSave()
+
+框架退出和每 15 分钟在 Worker #0 执行的代码。建议这里用来编写内存数据持久化的代码，如将 WorkerCache、内存全局变量存到文件。
+
+| 类型       | 值                             |
+| ---------- | ------------------------------ |
+| 名称       | `@OnSetup`                     |
+| 触发前提   | 每 15 分钟或 Ctrl+C、`server:stop` 等方式退出框架时               |
+| 命名空间   | `ZM\Annotation\Swoole\OnSave` |
+| 适用位置   | 方法                           |
+| 返回值处理 | 无                             |
+
+### 注解参数
+
+无。
+
 ## TerminalCommand()
 
 添加一个远程终端的自定义命令。（2.4.0 版本起可用）
@@ -430,4 +446,4 @@ public function onCrawl() {
 ## 示例6（创建一个远程终端命令并调试框架）
 
 > 开个坑，以后填。（__填坑标记__）
-> 
\ No newline at end of file
+>