From 98a60c64113539a347785f0ad39cd7c0e92189fb Mon Sep 17 00:00:00 2001
From: mackwang <mackwang@didichuxing.com>
Date: Wed, 15 Jan 2025 16:59:13 +0800
Subject: [PATCH] =?UTF-8?q?doc:=20=E8=A1=A5=E5=85=85=E9=80=89=E9=A1=B9?=
 =?UTF-8?q?=E5=BC=8Fapi=20options.shallowReactivePattern=20=E6=96=87?=
 =?UTF-8?q?=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs-vuepress/api/optional-api.md | 52 +++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)

diff --git a/docs-vuepress/api/optional-api.md b/docs-vuepress/api/optional-api.md
index 6a67628eab..e69c6b145f 100644
--- a/docs-vuepress/api/optional-api.md
+++ b/docs-vuepress/api/optional-api.md
@@ -1,5 +1,57 @@
 # 选项式 API
 
+### options.shallowReactivePattern
+- **类型：** `RegExp`
+- **详细：**
+
+取消data/properties内数据的深度响应。
+
+适用于每次更新均为整体的更新而非局部少量数据更新的大型数据，可减少掉对应属性“数据响应初始化”以及“diff比较”两个阶段的耗时
+
+```html
+<!-- child -->
+<script>
+createComponent({
+  properties: {
+    bigPropData: Object
+  },
+  data: {
+    // 这个是视图上需要用到的大数据
+    bigData: { a: 0 }
+  },
+  options: {
+    // 配置具体哪些data或者properties需要忽略响应
+    shallowReactivePattern: /bigData|bigPropData/
+  }，
+  methods: {
+    foo() {
+      this.bigData = { a: 1 } // 可触发视图更新
+    },
+    bar() {
+      this.bigData.a = 2 // 不可触发视图更新
+    }
+  }
+})
+</script>
+
+<!-- perant -->
+<template>
+  <child bigPropData="{{parentBigData}}"/>
+</template>
+<script>
+createComponent({
+  data: {
+    parentBigData: []
+  },
+  options: {
+    shallowReactivePattern: /parentBigData/ // 父组件中传入的data也需要开启shallowReactive
+  }
+})
+</script>
+```
+
+> 注意
+
 ### onAppInit
 - **类型：** `Function`
 - **详细：**