TypeScript | TanStack Query Angular Docs

TanStack Query 现在使用 TypeScript 编写，以确保库和您的项目都是类型安全的！

需要注意的事项：

类型目前需要使用 TypeScript v4.7 或更高版本
此存储库中类型的更改被视为非重大更改，通常作为补丁 semver 更改发布（否则每次类型增强都将是一个主要版本！）。
强烈建议您将 angular-query-experimental 包版本锁定到特定的补丁版本，并在升级时预期类型在任何版本之间都可能被修复或升级
TanStack Query 的非类型相关公共 API 仍然严格遵循 semver。

类型推断

TanStack Query 中的类型通常可以很好地传递，因此您不必自己提供类型注释

angular-ts

@Component({
  // ...
  template: `@let data = query.data();`,
  //               ^? data: number | undefined
})
class MyComponent {
  query = injectQuery(() => ({
    queryKey: ['test'],
    queryFn: () => Promise.resolve(5),
  }))
}

@Component({
  // ...
  template: `@let data = query.data();`,
  //               ^? data: number | undefined
})
class MyComponent {
  query = injectQuery(() => ({
    queryKey: ['test'],
    queryFn: () => Promise.resolve(5),
  }))
}

angular-ts

@Component({
  // ...
  template: `@let data = query.data();`,
  //               ^? data: string | undefined
})
class MyComponent {
  query = injectQuery(() => ({
    queryKey: ['test'],
    queryFn: () => Promise.resolve(5),
    select: (data) => data.toString(),
  }))
}

@Component({
  // ...
  template: `@let data = query.data();`,
  //               ^? data: string | undefined
})
class MyComponent {
  query = injectQuery(() => ({
    queryKey: ['test'],
    queryFn: () => Promise.resolve(5),
    select: (data) => data.toString(),
  }))
}

如果您的 queryFn 具有明确定义的返回类型，则此方法效果最佳。请记住，大多数数据获取库默认返回 any，因此请确保将其提取到正确类型的函数中：

在此示例中，我们将 Group[] 传递给 HttpClient 的 get 方法的类型参数。

angular-ts

@Component({
  template: `@let data = query.data();`,
  //               ^? data: Group[] | undefined
})
class MyComponent {
  http = inject(HttpClient)

  query = injectQuery(() => ({
    queryKey: ['groups'],
    queryFn: () => lastValueFrom(this.http.get<Group[]>('/groups')),
  }))
}

@Component({
  template: `@let data = query.data();`,
  //               ^? data: Group[] | undefined
})
class MyComponent {
  http = inject(HttpClient)

  query = injectQuery(() => ({
    queryKey: ['groups'],
    queryFn: () => lastValueFrom(this.http.get<Group[]>('/groups')),
  }))
}

类型收窄

TanStack Query 对查询结果使用可区分联合类型，由 status 字段和派生的状态布尔标志进行区分。这将允许您检查例如 isSuccess() 状态以使 data 定义：

angular-ts

@Component({
  // ...
  template: `
    @if (query.isSuccess()) {
      @let data = query.data();
      //    ^? data: number
    }
  `,
})
class MyComponent {
  query = injectQuery(() => ({
    queryKey: ['test'],
    queryFn: () => Promise.resolve(5),
  }))
}

@Component({
  // ...
  template: `
    @if (query.isSuccess()) {
      @let data = query.data();
      //    ^? data: number
    }
  `,
})
class MyComponent {
  query = injectQuery(() => ({
    queryKey: ['test'],
    queryFn: () => Promise.resolve(5),
  }))
}

TypeScript 当前不支持对象方法上的鉴别联合。对象（例如查询结果）上信号字段的收窄仅适用于返回布尔值的信号。优先使用 isSuccess() 和类似的布尔状态信号，而不是 status() === 'success'。

键入错误字段

错误字段的类型默认为 Error，因为这是大多数用户所期望的。

angular-ts

@Component({
  // ...
  template: `@let error = query.error();`,
  //                ^? error: Error | null
})
class MyComponent {
  query = injectQuery(() => ({
    queryKey: ['groups'],
    queryFn: fetchGroups
  }))
}

@Component({
  // ...
  template: `@let error = query.error();`,
  //                ^? error: Error | null
})
class MyComponent {
  query = injectQuery(() => ({
    queryKey: ['groups'],
    queryFn: fetchGroups
  }))
}

如果您想抛出自定义错误，或者根本不是 Error 的东西，您可以指定错误字段的类型：

angular-ts

@Component({
  // ...
  template: `@let error = query.error();`,
  //                ^? error: string | null
})
class MyComponent {
  query = injectQuery<Group[], string>(() => ({
    queryKey: ['groups'],
    queryFn: fetchGroups,
  }))
}

@Component({
  // ...
  template: `@let error = query.error();`,
  //                ^? error: string | null
})
class MyComponent {
  query = injectQuery<Group[], string>(() => ({
    queryKey: ['groups'],
    queryFn: fetchGroups,
  }))
}

然而，这样做的缺点是 injectQuery 的所有其他泛型的类型推断将不再起作用。通常不认为抛出非 Error 的东西是一个好习惯，因此如果您有一个像 AxiosError 这样的子类，您可以使用_类型收窄_来使错误字段更具体：

import axios from 'axios'

query = injectQuery(() => ({ queryKey: ['groups'], queryFn: fetchGroups }))

computed(() => {
  const error = query.error()
  //     ^? error: Error | null

  if (axios.isAxiosError(error)) {
    error
    // ^? const error: AxiosError
  }
})

import axios from 'axios'

query = injectQuery(() => ({ queryKey: ['groups'], queryFn: fetchGroups }))

computed(() => {
  const error = query.error()
  //     ^? error: Error | null

  if (axios.isAxiosError(error)) {
    error
    // ^? const error: AxiosError
  }
})

注册全局错误

TanStack Query v5 提供了一种为所有内容设置全局错误类型的方法，而无需在调用端指定泛型，方法是修改 Register 接口。这将确保推断仍然有效，但错误字段将是指定的类型：

import '@tanstack/angular-query-experimental'

declare module '@tanstack/angular-query-experimental' {
  interface Register {
    defaultError: AxiosError
  }
}

const query = injectQuery(() => ({
  queryKey: ['groups'],
  queryFn: fetchGroups,
}))

computed(() => {
  const error = query.error()
  //      ^? error: AxiosError | null
})

import '@tanstack/angular-query-experimental'

declare module '@tanstack/angular-query-experimental' {
  interface Register {
    defaultError: AxiosError
  }
}

const query = injectQuery(() => ({
  queryKey: ['groups'],
  queryFn: fetchGroups,
}))

computed(() => {
  const error = query.error()
  //      ^? error: AxiosError | null
})

键入元数据

注册全局元数据

与注册全局错误类型类似，您也可以注册全局 Meta 类型。这可确保查询和变更上的可选 meta 字段保持一致且类��安全。请注意，注册的类型必须扩展 Record<string, unknown>，以便 meta 保持为对象。

tsx

import '@tanstack/angular-query-experimental'

interface MyMeta extends Record<string, unknown> {
  // 您的元类型定义。
}

declare module '@tanstack/angular-query-experimental' {
  interface Register {
    queryMeta: MyMeta
    mutationMeta: MyMeta
  }
}

import '@tanstack/angular-query-experimental'

interface MyMeta extends Record<string, unknown> {
  // 您的元类型定义。
}

declare module '@tanstack/angular-query-experimental' {
  interface Register {
    queryMeta: MyMeta
    mutationMeta: MyMeta
  }
}

键入查询和变更键

注册查询和变更键类型

同样，与注册全局错误类型类似，您也可以注册全局 QueryKey 和 MutationKey 类型。这允许您为您的键提供更符合应用程序层次结构的结构，并在库的所有表面区域对它们进行类型化。请注意，注册的类型必须扩展 Array 类型，以便您的键保持为数组。

tsx

import '@tanstack/angular-query-experimental'

type QueryKey = ['dashboard' | 'marketing', ...ReadonlyArray<unknown>]

declare module '@tanstack/angular-query-experimental' {
  interface Register {
    queryKey: QueryKey
    mutationKey: QueryKey
  }
}

import '@tanstack/angular-query-experimental'

type QueryKey = ['dashboard' | 'marketing', ...ReadonlyArray<unknown>]

declare module '@tanstack/angular-query-experimental' {
  interface Register {
    queryKey: QueryKey
    mutationKey: QueryKey
  }
}

键入查询选项

如果将查询选项内联到 injectQuery 中，您将获得自动类型推断。但是，您可能希望将查询选项提取到一个单独的函数中，以便在 injectQuery 和例如 prefetchQuery 之间共享它们，或者在服务中管理它们。在这种情况下，您将失去类型推断。要恢复它，可以使用 queryOptions 辅助函数：

@Injectable({
  providedIn: 'root',
})
export class QueriesService {
  private http = inject(HttpClient)

  post(postId: number) {
    return queryOptions({
      queryKey: ['post', postId],
      queryFn: () => {
        return lastValueFrom(
          this.http.get<Post>(
            `https://jsonplaceholder.typicode.com/posts/${postId}`,
          ),
        )
      },
    })
  }
}

@Component({
  // ...
})
export class Component {
  queryClient = inject(QueryClient)

  postId = signal(1)

  queries = inject(QueriesService)
  optionsSignal = computed(() => this.queries.post(this.postId()))

  postQuery = injectQuery(() => this.queries.post(1))
  postQuery = injectQuery(() => this.queries.post(this.postId()))

  // 您还可以传递一个返回查询选项的信号
  postQuery = injectQuery(this.optionsSignal)

  someMethod() {
    this.queryClient.prefetchQuery(this.queries.post(23))
  }
}

@Injectable({
  providedIn: 'root',
})
export class QueriesService {
  private http = inject(HttpClient)

  post(postId: number) {
    return queryOptions({
      queryKey: ['post', postId],
      queryFn: () => {
        return lastValueFrom(
          this.http.get<Post>(
            `https://jsonplaceholder.typicode.com/posts/${postId}`,
          ),
        )
      },
    })
  }
}

@Component({
  // ...
})
export class Component {
  queryClient = inject(QueryClient)

  postId = signal(1)

  queries = inject(QueriesService)
  optionsSignal = computed(() => this.queries.post(this.postId()))

  postQuery = injectQuery(() => this.queries.post(1))
  postQuery = injectQuery(() => this.queries.post(this.postId()))

  // 您还可以传递一个返回查询选项的信号
  postQuery = injectQuery(this.optionsSignal)

  someMethod() {
    this.queryClient.prefetchQuery(this.queries.post(23))
  }
}

此外，从 queryOptions 返回的 queryKey 知道与其关联的 queryFn，我们可以利用该类型信息使诸如 queryClient.getQueryData 之类的函数也知道这些类型：

data = this.queryClient.getQueryData(groupOptions().queryKey)
// ^? data: Post | undefined

data = this.queryClient.getQueryData(groupOptions().queryKey)
// ^? data: Post | undefined

如果没有 queryOptions，数据的类型将是未知的，除非我们传递一个类型参数：

data = queryClient.getQueryData<Post>(['post', 1])

data = queryClient.getQueryData<Post>(['post', 1])

键入变更选项

与 queryOptions 类似，您可以使用 mutationOptions 将变更选项提取到一个单独的函数中：

export class QueriesService {
  private http = inject(HttpClient)

  updatePost(id: number) {
    return mutationOptions({
      mutationFn: (post: Post) => Promise.resolve(post),
      mutationKey: ['updatePost', id],
      onSuccess: (newPost) => {
        //           ^? newPost: Post
        this.queryClient.setQueryData(['posts', id], newPost)
      },
    })
  }
}

export class QueriesService {
  private http = inject(HttpClient)

  updatePost(id: number) {
    return mutationOptions({
      mutationFn: (post: Post) => Promise.resolve(post),
      mutationKey: ['updatePost', id],
      onSuccess: (newPost) => {
        //           ^? newPost: Post
        this.queryClient.setQueryData(['posts', id], newPost)
      },
    })
  }
}

使用 skipToken 对查询进行类型安全的禁用

如果您正在使用 TypeScript，则可以使用 skipToken 来禁用查询。当您想根据条件禁用查询，但仍希望保持查询类型安全时，这很有用。在禁用查询指南中阅读更多相关信息。