Skip to content

Commit 7b17d33

Browse files
naokihabajay-es
andauthored
docs: 3.5: watch deep support number (#2276)
* doc: update WatchOptions deep property to accept a number value * feat: Add support for deep option in watchers * feat: Improve Japanese translation for deep option in watchers * feat: Update deep option in watchers to support specifying the maximum search depth * Update src/guide/essentials/watchers.md Co-authored-by: Jun Shindo <[email protected]> --------- Co-authored-by: Jun Shindo <[email protected]>
1 parent 46c967d commit 7b17d33

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

src/api/reactivity-core.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@
403403
404404
interface WatchOptions extends WatchEffectOptions {
405405
immediate?: boolean // 初期値: false
406-
deep?: boolean // 初期値: false
406+
deep?: boolean | number // 初期値: false
407407
flush?: 'pre' | 'post' | 'sync' // 初期値: 'pre'
408408
onTrack?: (event: DebuggerEvent) => void
409409
onTrigger?: (event: DebuggerEvent) => void
@@ -438,7 +438,7 @@
438438
省略可能な第 3 引数は、以下のオプションをサポートするオプションオブジェクトです:
439439

440440
- **`immediate`**: ウォッチャーが作成されたら、すぐにコールバックを起動します。最初の呼び出しでは、古い値は `undefined` になります。
441-
- **`deep`**: オブジェクトの場合、深い変更の際にコールバックが発生するように、ソースの深い探索を強制します。詳しくは[ディープ・ウォッチャー](/guide/essentials/watchers#deep-watchers)をご参照ください。
441+
- **`deep`**: オブジェクトの場合、深い変更の際にコールバックが発生するように、ソースの深い探索を強制します。3.5+ では、どこまで深くオブジェクトを監視するかを数値で指定することもできます。詳しくは[ディープ・ウォッチャー](/guide/essentials/watchers#deep-watchers)をご参照ください。
442442
- **`flush`**: コールバックのフラッシュタイミングを調整します。詳しくは[コールバックが実行されるタイミング](/guide/essentials/watchers#callback-flush-timing)や [`watchEffect()`](/api/reactivity-core#watcheffect) をご参照ください。
443443
- **`onTrack / onTrigger`**: ウォッチャーの依存関係をデバッグします。詳しくは[ウォッチャーのデバッグ](/guide/extras/reactivity-in-depth#watcher-debugging)をご参照ください。
444444
- **`once`**: コールバックを一度だけ実行します。最初のコールバックが実行されると、ウォッチャーは自動的に停止します。<sup class="vt-badge" data-text="3.4+" />

src/guide/essentials/watchers.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,8 @@ watch(
224224

225225
</div>
226226

227+
Vue 3.5+ では、`deep` オプションは、最大探索深度を示す数値、つまり、Vue がオブジェクトのネストしたプロパティを何階層まで探索するかを示す数値も指定可能です。
228+
227229
:::warning 使用上の注意
228230
deep watch は、監視対象のオブジェクトのネストされた全てのプロパティをトラバースする必要があるため、大きなデータ構造で使用するときにはコストが高くなります。使用するときは、どうしても必要なときにだけ使用し、パフォーマンスへの影響に注意しましょう。
229231
:::

0 commit comments

Comments
 (0)