⬅️ Back to Table of Contents

📄 _configurable

📊 Analysis Summary

Metric	Count
📦 Imports	3
📊 Variables & Constants	4
📐 Interfaces	7

📚 Table of Contents

• Imports
• Variables & Constants
• Interfaces

🛠️ File Location:

📂 packages/core/_configurable.ts

📦 Imports

Name	Source
Fn	@vueuse/shared
Pausable	@vueuse/shared
isClient	@vueuse/shared

---

Variables & Constants

Name	Type	Kind	Value	Exported
defaultWindow	Window & typeof globalThis	const	isClient ? window : undefined	✓
defaultDocument	Document	const	isClient ? window.document : undefined	✓
defaultNavigator	Navigator	const	isClient ? window.navigator : undefined	✓
defaultLocation	Location	const	isClient ? window.location : undefined	✓

---

Interfaces

ConfigurableWindow

Interface Code

export interface ConfigurableWindow {
  /*
   * Specify a custom `window` instance, e.g. working with iframes or in testing environments.
   */
  window?: Window
}

Properties

Name	Type	Optional	Description
window	Window	✓	not shown

ConfigurableDocument

Interface Code

export interface ConfigurableDocument {
  /*
   * Specify a custom `document` instance, e.g. working with iframes or in testing environments.
   */
  document?: Document
}

Properties

Name	Type	Optional	Description
document	Document	✓	not shown

ConfigurableDocumentOrShadowRoot

Interface Code

export interface ConfigurableDocumentOrShadowRoot {
  /*
   * Specify a custom `document` instance or a shadow root, e.g. working with iframes or in testing environments.
   */
  document?: DocumentOrShadowRoot
}

Properties

Name	Type	Optional	Description
document	DocumentOrShadowRoot	✓	not shown

ConfigurableNavigator

Interface Code

export interface ConfigurableNavigator {
  /*
   * Specify a custom `navigator` instance, e.g. working with iframes or in testing environments.
   */
  navigator?: Navigator
}

Properties

Name	Type	Optional	Description
navigator	Navigator	✓	not shown

ConfigurableLocation

Interface Code

export interface ConfigurableLocation {
  /*
   * Specify a custom `location` instance, e.g. working with iframes or in testing environments.
   */
  location?: Location
}

Properties

Name	Type	Optional	Description
location	Location	✓	not shown

ConfigurableDeepRefs<D extends boolean>

Interface Code

export interface ConfigurableDeepRefs<D extends boolean> {
  /**
   * Return deep refs instead of shallow refs.
   *
   * @default true - will be changed to `false` by default in the next major
   */
  deepRefs?: D
}

Properties

Name	Type	Optional	Description
deepRefs	D	✓	not shown

ConfigurableScheduler

Interface Code

export interface ConfigurableScheduler {
  /**
   * Custom scheduler to use for interval execution.
   */
  scheduler?: (cb: Fn) => Pausable
}

Properties

Name	Type	Optional	Description
scheduler	(cb: Fn) => Pausable	✓	not shown

---

Generated by Syntax Scribe