@haddowg/json-api-angular

中文文档
1.2.23发布于 2026/11/17MITTypeScriptESM + CJS构建来源已验证近 30 天下载 4940

基于信号的Angular绑定JSON:API客户端:一款HttpClient运输,DI提供商,以及资源/mutation帮助器.

中文使用文档
文档目录5 节
  1. 安装
  2. 提供客户端
  3. 用资源读取
  4. 写作突变
  5. 许可证

@ haddowg/ json- api- angula

部分 jsonapi.rest (英语) 套间 - 完整、符合规格 JSON: API 1. 1 堆栈: 框架不可知 PHP 核心项目页:1 符号捆绑页:1 Laravel 软件包这个 键入类型脚本 客户端,由经过检测的OpenAPI 3.1合同捆绑在一起. 完整文档: (原始内容存档于2018-10-21) (韩语). haddog.github.io/json-api-ts。 。 。 .

生成的基于信号的角绑定 @haddowg/json-api-client客户端 进入依赖性注射 并通过Angular发送 HttpClient,所以你的拦截器运行 每一个请求。 读取通过Angular成为信号 resource(),写一个小 以信号为基础的变异手柄.

安装

npm install @haddowg/json-api-angular @haddowg/json-api-client

@angular/core 财务报告和审定财务报表 @angular/common (20, 21或22)是同级依赖关系.

提供客户端

import { provideHttpClient, withInterceptors } from '@angular/common/http'
import { provideJsonApiClient } from '@haddowg/json-api-angular'
import { createClient } from './api/music.gen'

export const appConfig: ApplicationConfig = {
  providers: [
    provideHttpClient(withInterceptors([authInterceptor])),
    provideJsonApiClient(createClient, { baseUrl: '/api/v5' }),
  ],
}

注册客户端类型一次, 这样它会无符号地输入 :

import type { JsonApiClientOf } from '@haddowg/json-api-angular'

declare module '@haddowg/json-api-angular' {
  interface Register {
    client: JsonApiClientOf<typeof createClient>
  }
}

对于第二个客户端(另一个服务器),用 createJsonApiClientToken() 传过来 作为第三个参数 provideJsonApiClient,然后改为 injectJsonApiClient(token) 或一个 资源 client 选项.

用资源读取

@Component({
  template: `
    @if (albums.hasValue()) {
      @for (album of albums.value(); track album.id) {
        <li>{{ album.title }} by {{ album.artist?.name }}</li>
      }
    }
    @if (albums.jsonApiError(); as error) {
      <p>{{ error.status }}</p>
    }
  `,
})
export class AlbumList {
  readonly search = signal('')

  readonly albums = jsonApiResource({
    params: () => ({ filter: { title: this.search() } }),
    loader: ({ client, params, abortSignal }) =>
      client.albums.list({ ...params, include: ['artist'], signal: abortSignal }),
  })
}

变化 search 开始新的读取并取消飞行中的读取。 返回时 undefined 从 params 将读取直到其投入准备好。 与任何角资源一样, value() 丢入出错状态, 所以用 hasValue()。 。 。 .

nextPage(list) 财务报告和审定财务报表 prevPage(list) 返回 page 收藏链接中的参数,准备 设置在读取的参数上的信号上. loadAll(firstPage, { signal }) 如下 next 链接和 返回一个数组中的每个成员.

写作突变

readonly rename = jsonApiMutation((client, title: string) =>
  client.albums.id(this.id()).update({ title }),
)

save(title: string) {
  this.rename.mutate(title).then(() => this.albums.reload(), () => {})
}

isPending(), (中文(简体) ), error(), (中文(简体) ), jsonApiError(), (中文(简体) ), value() 财务报告和审定财务报表 reset() 跟踪最新通话。 没什么 在资源之间被缓存,所以重新装入读取的写入影响 .

见 角向导 关于细节.

许可证

麻省理工学院

版本与发布记录

@haddowg/json-api-angular 共发布 29 个版本,首次发布于 2026/10/22;过去 12 个月发布了 29 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.2.23latest2026/11/17今天
1.2.222026/11/17今天
1.2.212026/11/16今天
1.2.202026/11/133 天前
1.2.192026/11/134 天前
1.2.182026/11/124 天前

关于 @haddowg/json-api-angular 的常见问题

@haddowg/json-api-angular 是什么?

基于信号的Angular绑定JSON:API客户端:一款HttpClient运输,DI提供商,以及资源/mutation帮助器.

如何安装 @haddowg/json-api-angular?

在项目目录运行 npm install @haddowg/json-api-angular,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@angular/core(^20.0.0 || ^21.0.0 || ^22.0.0)、@angular/common(^20.0.0 || ^21.0.0 || ^22.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@haddowg/json-api-angular 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@haddowg/json-api-angular 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@haddowg/json-api-angular 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@haddowg/json-api-angular 可以商用吗?

@haddowg/json-api-angular 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@haddowg/json-api-angular 的下载量有多少?

根据 npm 官方下载统计,@haddowg/json-api-angular 在 2026/10/17 – 2026/11/15 这 30 天内被下载 4,940 次,日均约 165 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@haddowg/json-api-angular 还在维护吗?

最新版本 1.2.23 发布于 2026/11/17(今天);至今共发布 29 个版本,其中过去 12 个月发布了 29 个;首次发布于 2026/10/22。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。