⬅️ Back to Table of Contents

📄 ssr-handlers

📊 Analysis Summary

Metric	Count
🔧 Functions	3
📦 Imports	2
📊 Variables & Constants	2
📐 Interfaces	3

📚 Table of Contents

• Imports
• Variables & Constants
• Functions
• Interfaces

🛠️ File Location:

📂 packages/core/ssr-handlers.ts

📦 Imports

Name	Source
Awaitable	@vueuse/shared
MaybeElementRef	./unrefElement

---

Variables & Constants

Name	Type	Kind	Value	Exported
_global	{}	const	typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined...	✗
globalKey	"__vueuse_ssr_handlers__"	const	'__vueuse_ssr_handlers__'	✗

---

Functions

getSSRHandler(key: T, fallback: SSRHandlersMap[T]): SSRHandlersMap[T]

Parameters:

• key T
• fallback SSRHandlersMap[T]

Returns: SSRHandlersMap[T]

Code

export function getSSRHandler<T extends keyof SSRHandlersMap>(key: T, fallback: SSRHandlersMap[T]): SSRHandlersMap[T]

setSSRHandler(key: T, fn: SSRHandlersMap[T]): void

Parameters:

• key T
• fn SSRHandlersMap[T]

Returns: void

Code

export function setSSRHandler<T extends keyof SSRHandlersMap>(key: T, fn: SSRHandlersMap[T]) {
  handlers[key] = fn
}

getHandlers(): Partial<SSRHandlersMap>

Returns: Partial<SSRHandlersMap>

Internal Comments:

// @ts-expect-error inject global (x5)

Code

function getHandlers() {
  if (!(globalKey in _global))
    // @ts-expect-error inject global
    _global[globalKey] = _global[globalKey] || {}
  // @ts-expect-error inject global
  return _global[globalKey] as Partial<SSRHandlersMap>
}

---

Interfaces

StorageLikeAsync

Interface Code

export interface StorageLikeAsync {
  getItem: (key: string) => Awaitable<string | null>
  setItem: (key: string, value: string) => Awaitable<void>
  removeItem: (key: string) => Awaitable<void>
}

Properties

Name	Type	Optional	Description
getItem	(key: string) => Awaitable<string \| null>	✗	not shown
setItem	(key: string, value: string) => Awaitable<void>	✗	not shown
removeItem	(key: string) => Awaitable<void>	✗	not shown

StorageLike

Interface Code

export interface StorageLike {
  getItem: (key: string) => string | null
  setItem: (key: string, value: string) => void
  removeItem: (key: string) => void
}

Properties

Name	Type	Optional	Description
getItem	(key: string) => string \| null	✗	not shown
setItem	(key: string, value: string) => void	✗	not shown
removeItem	(key: string) => void	✗	not shown

SSRHandlersMap

Interface Code

export interface SSRHandlersMap {
  getDefaultStorage: () => StorageLike | undefined
  getDefaultStorageAsync: () => StorageLikeAsync | undefined
  updateHTMLAttrs: (selector: string | MaybeElementRef, attribute: string, value: string) => void
}

Properties

Name	Type	Optional	Description
getDefaultStorage	() => StorageLike \| undefined	✗	not shown
getDefaultStorageAsync	() => StorageLikeAsync \| undefined	✗	not shown
updateHTMLAttrs	(selector: string \| MaybeElementRef, attribute: string, value: string) => void	✗	not shown

---

Generated by Syntax Scribe