mirror of
https://github.com/nuxt/nuxt.git
synced 2025-02-18 22:51:02 +00:00
58 lines
1.5 KiB
TypeScript
58 lines
1.5 KiB
TypeScript
import { AsyncLocalStorage } from 'node:async_hooks'
|
|
import { createContext, getContext } from 'unctx'
|
|
import type { Nuxt } from '@nuxt/schema'
|
|
|
|
/**
|
|
* Direct access to the Nuxt global context - see https://github.com/unjs/unctx.
|
|
* @deprecated Use `getNuxtCtx` instead
|
|
*/
|
|
export const nuxtCtx = getContext<Nuxt>('nuxt')
|
|
|
|
/** async local storage for the name of the current nuxt instance */
|
|
const asyncNuxtStorage = createContext<Nuxt>({
|
|
asyncContext: true,
|
|
AsyncLocalStorage,
|
|
})
|
|
|
|
/** Direct access to the Nuxt context with asyncLocalStorage - see https://github.com/unjs/unctx. */
|
|
export const getNuxtCtx = () => asyncNuxtStorage.tryUse()
|
|
|
|
// TODO: Use use/tryUse from unctx. https://github.com/unjs/unctx/issues/6
|
|
|
|
/**
|
|
* Get access to Nuxt instance.
|
|
*
|
|
* Throws an error if Nuxt instance is unavailable.
|
|
* @example
|
|
* ```js
|
|
* const nuxt = useNuxt()
|
|
* ```
|
|
*/
|
|
export function useNuxt (): Nuxt {
|
|
const instance = asyncNuxtStorage.tryUse() || nuxtCtx.tryUse()
|
|
if (!instance) {
|
|
throw new Error('Nuxt instance is unavailable!')
|
|
}
|
|
return instance
|
|
}
|
|
|
|
/**
|
|
* Get access to Nuxt instance.
|
|
*
|
|
* Returns null if Nuxt instance is unavailable.
|
|
* @example
|
|
* ```js
|
|
* const nuxt = tryUseNuxt()
|
|
* if (nuxt) {
|
|
* // Do something
|
|
* }
|
|
* ```
|
|
*/
|
|
export function tryUseNuxt (): Nuxt | null {
|
|
return asyncNuxtStorage.tryUse() || nuxtCtx.tryUse()
|
|
}
|
|
|
|
export function runWithNuxtContext<T extends (...args: any[]) => any> (nuxt: Nuxt, fn: T) {
|
|
return asyncNuxtStorage.call(nuxt, fn) as ReturnType<T>
|
|
}
|