Skip to content

@airiot/clientAiriot TypeScript 客户端库

为 React 应用提供完整的 API、认证、表单处理和模型管理功能

Airiot Client

安装

bash
npm install @airiot/client

快速开始

typescript
import { createAPI, setConfig } from '@airiot/client'

// 配置全局上下文
setConfig({
  language: 'zh-CN',
  module: 'admin'
})

// 创建 API 实例
const api = createAPI({
  name: 'core/user',
  resource: 'user'
})

// 查询数据
const { items, total } = await api.query({
  skip: 0,
  limit: 10
})

核心功能

API 客户端

简化 REST API 调用,支持查询、过滤、分页等常用操作。

typescript
const { items, total } = await api.query({
  skip: 0,
  limit: 10,
  order: { createdAt: 'DESC' }
})

身份认证

完整的登录/登出流程,支持记住我功能。

typescript
const { onLogin } = useLogin()

await onLogin({
  username: 'admin',
  password: 'password',
  remember: true
})

表单处理

基于 JSON Schema 的表单构建和验证,支持自定义字段渲染器和验证规则。

typescript
import { SchemaForm, setFormFields, setSchemaConverters } from '@airiot/client'

// 自定义字段渲染器
setFormFields({
  custom: CustomComponent
})

// 自定义 Schema 转换器
setSchemaConverters([
  (field, schema) => {
    if (schema.custom) {
      field.type = 'custom'
    }
    return field
  }
])

<SchemaForm
  schema={userSchema}
  onSubmit={handleSubmit}
/>

模型管理

集成的状态管理和数据操作。

typescript
<Model model={userModel}>
  <UserList />
</Model>

为什么选择 @airiot/client?

  • 开发效率 - 内置常用功能,减少重复代码
  • 类型安全 - TypeScript 类型定义,减少运行时错误
  • 最佳实践 - 遵循 React 和 TypeScript 最佳实践
  • 文档完善 - 详细的文档和示例
  • 活跃维护 - 持续更新和改进
  • 社区支持 - 丰富的社区资源和案例

了解更多

探索以下资源来更好地使用 @airiot/client:

浏览器支持

支持所有现代浏览器。

ChromeFirefoxSafariEdge
LatestLatestLatestLatest

许可证

MIT License

MIT Licensed