Skip to content

docs(refDebounce,refThrottled): add usage example with object ref #4898

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 22, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs(refDebounced): add usage example with object ref
Co-authored-by: XavierChevalier <XavierChevalier@users.noreply.github.com>
  • Loading branch information
ilyaliao and XavierChevalier committed Jul 21, 2025
commit 29909b9147672fc0a886db7b5b73d8189d8b2e62
26 changes: 26 additions & 0 deletions packages/shared/refDebounced/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,32 @@ await sleep(1100)
console.log(debounced.value) // 'bar'
```

An example with object ref.

```js {5}
import { refDebounced } from '@vueuse/core'
import { shallowRef } from 'vue';

const data = shallowRef({
name: 'foo',
age: 18,
})
const debounced = refDebounced(data, 1000)

function update() {
data.value = {
...data.value,
name: 'bar',
}
}

console.log(debounced.value) // { name: 'foo', age: 18 }

await sleep(1100)

console.log(debounced.value) // { name: 'bar', age: 18 }
```

You can also pass an optional 3rd parameter including maxWait option. See `useDebounceFn` for details.

## Recommended Reading
Expand Down
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy