Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2024-11-13 09:33:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(nuxt): support async transforms for data composables (#26154)

Browse Source
This commit is contained in:
Daniel Roe 2024-03-08 19:22:46 +00:00 committed by GitHub
parent 4023f7c824
commit 0cc7f298f9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/3.api/2.composables/use-async-data.md
View File

@ -119,7 +119,7 @@ type AsyncDataOptions<DataT> = {
deep?: boolean deep?: boolean
dedupe?: 'cancel' | 'defer' dedupe?: 'cancel' | 'defer'
default?: () => DataT | Ref<DataT> | null default?: () => DataT | Ref<DataT> | null
transform?: (input: DataT) => DataT transform?: (input: DataT) => DataT | Promise<DataT>
pick?: string[] pick?: string[]
watch?: WatchSource[] watch?: WatchSource[]
getCachedData?: (key: string) => DataT getCachedData?: (key: string) => DataT

2
docs/3.api/2.composables/use-fetch.md
View File

@ -148,7 +148,7 @@ type UseFetchOptions<DataT> = {
deep?: boolean deep?: boolean
dedupe?: 'cancel' | 'defer' dedupe?: 'cancel' | 'defer'
default?: () => DataT default?: () => DataT
transform?: (input: DataT) => DataT transform?: (input: DataT) => DataT | Promise<DataT>
pick?: string[] pick?: string[]
watch?: WatchSource[] | false watch?: WatchSource[] | false
} }

6
packages/nuxt/src/app/composables/asyncData.ts
View File

@ -12,7 +12,7 @@ import { asyncDataDefaults } from '#build/nuxt.config.mjs'
export type AsyncDataRequestStatus = 'idle' | 'pending' | 'success' | 'error' export type AsyncDataRequestStatus = 'idle' | 'pending' | 'success' | 'error'
export type _Transform<Input = any, Output = any> = (input: Input) => Output export type _Transform<Input = any, Output = any> = (input: Input) => Output | Promise<Output>
export type PickFrom<T, K extends Array<string>> = T extends Array<any> export type PickFrom<T, K extends Array<string>> = T extends Array<any>
? T ? T
@ -283,13 +283,13 @@ export function useAsyncData<
reject(err) reject(err)
} }
}) })
.then((_result) => { .then(async (_result) => {
// If this request is cancelled, resolve to the latest request. // If this request is cancelled, resolve to the latest request.
if ((promise as any).cancelled) { return nuxtApp._asyncDataPromises[key] } if ((promise as any).cancelled) { return nuxtApp._asyncDataPromises[key] }
let result = _result as unknown as DataT let result = _result as unknown as DataT
if (options.transform) { if (options.transform) {
result = options.transform(_result) result = await options.transform(_result)
} }
if (options.pick) { if (options.pick) {
result = pick(result as any, options.pick) as DataT result = pick(result as any, options.pick) as DataT

10
test/fixtures/basic-types/types.ts vendored
View File

@ -418,6 +418,16 @@ describe('composables', () => {
expectTypeOf(useLazyAsyncData<string>(() => $fetch('/test'), { default: () => 'test', transform: () => 'transformed' }).data).toEqualTypeOf<Ref<string>>() expectTypeOf(useLazyAsyncData<string>(() => $fetch('/test'), { default: () => 'test', transform: () => 'transformed' }).data).toEqualTypeOf<Ref<string>>()
}) })
it('supports asynchronous transform', () => {
const { data } = useAsyncData('test', () => $fetch('/test') as Promise<{ foo: 'bar' }>, {
async transform (data) {
await Promise.resolve()
return data.foo
}
})
expectTypeOf(data).toEqualTypeOf<Ref<'bar' | null>>()
})
it('infer request url string literal from server/api routes', () => { it('infer request url string literal from server/api routes', () => {
// request can accept dynamic string type // request can accept dynamic string type
const dynamicStringUrl = 'https://example.com/api' const dynamicStringUrl = 'https://example.com/api'