⬅️ Back to Table of Contents

📄 index.ts

📊 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>

Code

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

• JSDoc:

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

• Parameters:

• options: ConfigurableWindow
• Return Type: ShallowRef<boolean>
• Calls:
• useNetwork (from ../useNetwork)

---