⬅️ Back to Table of Contents

📄 useOnline

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	2

📚 Table of Contents

• Imports
• Functions

🛠️ File Location:

📂 packages/core/useOnline/index.ts

📦 Imports

Name	Source
ConfigurableWindow	../_configurable
useNetwork	../useNetwork

---

Functions

useOnline(options: ConfigurableWindow): ShallowRef<boolean>

Reactive online state.

Parameters:

• options any: No description

See: https://vueuse.org/useOnline

Tags: @__NO_SIDE_EFFECTS__

Raw JSDoc

/**
 * Reactive online state.
 *
 * @see https://vueuse.org/useOnline
 * @param options
 *
 * @__NO_SIDE_EFFECTS__
 */

Calls:

• useNetwork (from ../useNetwork)

Code

export function useOnline(options: ConfigurableWindow = {}) {
  const { isOnline } = useNetwork(options)
  return isOnline
}

---

Generated by Syntax Scribe