import { onBeforeMount, onServerPrefetch, onUnmounted, ref, getCurrentInstance } from 'vue' import type { Ref } from 'vue' import { NuxtApp, useNuxtApp } from '#app' export type _Transform = (input: Input) => Output export type PickFrom> = T extends Array ? T : T extends Record ? Pick : T export type KeysOf = Array export type KeyOfRes = KeysOf> export interface AsyncDataOptions< DataT, Transform extends _Transform = _Transform, PickKeys extends KeyOfRes<_Transform> = KeyOfRes > { server?: boolean lazy?: boolean default?: () => DataT transform?: Transform pick?: PickKeys } export interface _AsyncData { data: Ref pending: Ref refresh: (force?: boolean) => Promise error?: any } export type AsyncData = _AsyncData & Promise<_AsyncData> const getDefault = () => null export function useAsyncData< DataT, Transform extends _Transform = _Transform, PickKeys extends KeyOfRes = KeyOfRes > ( key: string, handler: (ctx?: NuxtApp) => Promise, options: AsyncDataOptions = {} ): AsyncData, PickKeys>> { // Validate arguments if (typeof key !== 'string') { throw new TypeError('asyncData key must be a string') } if (typeof handler !== 'function') { throw new TypeError('asyncData handler must be a function') } // Apply defaults options = { server: true, default: getDefault, ...options } // TODO: remove support for `defer` in Nuxt 3 RC if ((options as any).defer) { console.warn('[useAsyncData] `defer` has been renamed to `lazy`. Support for `defer` will be removed in RC.') } options.lazy = options.lazy ?? (options as any).defer ?? false // Setup nuxt instance payload const nuxt = useNuxtApp() // Setup hook callbacks once per instance const instance = getCurrentInstance() if (instance && !instance._nuxtOnBeforeMountCbs) { const cbs = instance._nuxtOnBeforeMountCbs = [] if (instance && process.client) { onBeforeMount(() => { cbs.forEach((cb) => { cb() }) cbs.splice(0, cbs.length) }) onUnmounted(() => cbs.splice(0, cbs.length)) } } const asyncData = { data: ref(nuxt.payload.data[key] ?? options.default()), pending: ref(true), error: ref(nuxt.payload._errors[key] ?? null) } as AsyncData asyncData.refresh = (force?: boolean) => { // Avoid fetching same key more than once at a time if (nuxt._asyncDataPromises[key] && !force) { return nuxt._asyncDataPromises[key] } asyncData.pending.value = true // TODO: Cancel previous promise // TODO: Handle immediate errors nuxt._asyncDataPromises[key] = Promise.resolve(handler(nuxt)) .then((result) => { if (options.transform) { result = options.transform(result) } if (options.pick) { result = pick(result, options.pick) as DataT } asyncData.data.value = result asyncData.error.value = null }) .catch((error: any) => { asyncData.error.value = error asyncData.data.value = options.default() }) .finally(() => { asyncData.pending.value = false nuxt.payload.data[key] = asyncData.data.value if (asyncData.error.value) { nuxt.payload._errors[key] = true } delete nuxt._asyncDataPromises[key] }) return nuxt._asyncDataPromises[key] } const fetchOnServer = options.server !== false && nuxt.payload.serverRendered // Server side if (process.server && fetchOnServer) { const promise = asyncData.refresh() onServerPrefetch(() => promise) } // Client side if (process.client) { if (fetchOnServer && nuxt.isHydrating) { // 1. Hydration (server: true): no fetch asyncData.pending.value = false } else if (instance && (nuxt.isHydrating || options.lazy)) { // 2. Initial load (server: false): fetch on mounted // 3. Navigation (lazy: true): fetch on mounted instance._nuxtOnBeforeMountCbs.push(asyncData.refresh) } else { // 4. Navigation (lazy: false) - or plugin usage: await fetch asyncData.refresh() } } // Allow directly awaiting on asyncData const asyncDataPromise = Promise.resolve(nuxt._asyncDataPromises[key]).then(() => asyncData) as AsyncData Object.assign(asyncDataPromise, asyncData) // @ts-ignore return asyncDataPromise as AsyncData } export function useLazyAsyncData< DataT, Transform extends _Transform = _Transform, PickKeys extends KeyOfRes = KeyOfRes > ( key: string, handler: (ctx?: NuxtApp) => Promise, options: Omit, 'lazy'> = {} ): AsyncData, PickKeys>> { return useAsyncData(key, handler, { ...options, lazy: true }) } function pick (obj: Record, keys: string[]) { const newObj = {} for (const key of keys) { newObj[key] = obj[key] } return newObj }