Function useAsyncData

packages/nuxt/src/app/composables/asyncData.ts:275–560

(...args: any[])

      opts?: AsyncDataOptions<ResT, DataT, PickKeys, DefaultT>,
    ): AsyncData<PickFrom<DataT, [Array<never>] extends [FPickKeys] ? PickKeys : FPickKeys & KeysOf<DataT>> | DefaultT, (NuxtErrorDataT extends Error | NuxtError ? NuxtErrorDataT : NuxtError<NuxtErrorDataT>) | undefined>
    function useAsyncData<
      ResT,
      NuxtErrorDataT = unknown,
      DataT = ResT,
      PickKeys extends KeysOf<DataT> = KeysOf<DataT>,
      DefaultT = undefined,
    > (...args: any[]): AsyncData<PickFrom<DataT, PickKeys>, (NuxtErrorDataT extends Error | NuxtError ? NuxtErrorDataT : NuxtError<NuxtErrorDataT>) | undefined> {
      const autoKey = typeof args[args.length - 1] === 'string' ? args.pop() : undefined
      if (_isAutoKeyNeeded(args[0], args[1])) { args.unshift(autoKey) }

      // eslint-disable-next-line prefer-const
      let [_key, _handler, opts = {}] = args as [MaybeRefOrGetter<string>, AsyncDataHandler<ResT>, AsyncDataOptions<ResT, DataT, PickKeys, DefaultT>]
      let keyChanging = false
      /** True if key is a Ref or getter; false for static string. When false, key watcher is skipped. */
      const isKeyReactive = isRef(_key) || typeof _key === 'function'

      // Validate arguments
      const key = (isKeyReactive ? computed(() => toValue(_key)!) : { value: _key as string }) as { readonly value: string }
      if (!key.value || typeof key.value !== 'string') {
        throw new TypeError('[nuxt] [useAsyncData] key must be a non-empty string.')
      }
      if (typeof _handler !== 'function') {
        throw new TypeError('[nuxt] [useAsyncData] handler must be a function.')
      }

      const shouldFactoryOptionsOverride = typeof options === 'function'

      // Setup nuxt instance payload
      const nuxtApp = useNuxtApp()

      const factoryOptions = shouldFactoryOptionsOverride ? options(opts as any) : options
      // assign factory defaults
      if (!shouldFactoryOptionsOverride) {
        for (const key in factoryOptions) {
          // factory doesn't have a value set for the key
          if (factoryOptions[key as keyof typeof factoryOptions] === undefined) { continue }
          // opts already has a value set for the key
          if (opts[key as keyof typeof opts] !== undefined) { continue }
          opts[key as keyof typeof opts] = factoryOptions[key as keyof typeof factoryOptions] as any
        }
      }

      opts.server ??= true
      opts.default ??= getDefault as () => DefaultT
      opts.getCachedData ??= getDefaultCachedData

      opts.lazy ??= false
      opts.immediate ??= true
      opts.deep ??= asyncDataDefaults.deep
      opts.dedupe ??= 'cancel'

      // assign overrides from factory
      if (shouldFactoryOptionsOverride) {
        for (const key in factoryOptions) {
          if (factoryOptions[key as keyof typeof factoryOptions] === undefined) { continue }
          opts[key as keyof typeof opts] = factoryOptions[key as keyof typeof factoryOptions] as any
        }
      }