Skip to main content

Documentation Index

Fetch the complete documentation index at: https://inertiajs.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Poll Helper

Polling your server for new information on the current page is common, so Inertia provides a poll helper designed to help reduce the amount of boilerplate code. In addition, the poll helper will automatically stop polling when the page is unmounted. The only required argument is the polling interval in milliseconds. 
import { usePoll } from '@inertiajs/vue3'

usePoll(2000)
If you need to pass additional request options to the poll helper, you can pass any of the router.reload options as the second parameter. 
import { usePoll } from '@inertiajs/vue3'

usePoll(2000, {
    onStart() {
        console.log('Polling request started')
    },
    onFinish() {
        console.log('Polling request finished')
    },
})
You may also pass a function that returns the request options. The function is evaluated on every tick, allowing the poll to reflect the latest component state. 
<script setup>
import { usePoll } from '@inertiajs/vue3'

const props = defineProps({ counter: Number })

usePoll(2000, () => ({
    data: { counter_seen: props.counter },
    only: ['last_received'],
}))
</script>
If you’d like more control over the polling behavior, the poll helper provides stop and start methods that allow you to manually start and stop polling. You can pass the autoStart: false option to the poll helper to prevent it from automatically starting polling when the component is mounted. 
<script setup>
import { usePoll } from '@inertiajs/vue3'

const { start, stop } = usePoll(2000, {}, {
    autoStart: false,
})
</script>

<template>
    <button @click="start">Start polling</button>
    <button @click="stop">Stop polling</button>
</template>

​
Concurrency Mode

By default, the poll helper fires a new request on every tick, even when the previous request is still in flight. You may control this behavior with the mode option, which accepts one of three values: overlap, cancel, or rest. The default overlap mode allows requests to run in parallel. The cancel mode aborts any in-flight request when the next tick fires. The rest mode treats the interval as the time between the end of the previous request and the start of the next one, so requests never overlap. 
import { usePoll } from '@inertiajs/vue3'

usePoll(2000, {}, {
    mode: 'rest',
})

​
Throttling

By default, the poll helper will throttle requests by 90% when the browser tab is in the background. If you’d like to disable this behavior, you can pass the keepAlive option to the poll helper. 
import { usePoll } from '@inertiajs/vue3'

usePoll(2000, {}, {
    keepAlive: true,
})