This generator creates TypeScript/JavaScript client that utilizes Fetch API. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
Building
To build and compile the typescript sources to javascript use:
npm install
npm run build
Publishing
First build the package then run npm publish
Consuming
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install @coraxai/[email protected] --save
unPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --save
关于 @coraxai/api-client 的常见问题
@coraxai/api-client 是什么?
OpenAPI client for @coraxai/api-client
如何安装 @coraxai/api-client?
在项目目录运行 npm install @coraxai/api-client,或使用 pnpm add / yarn add / bun add。
@coraxai/api-client 支持 TypeScript 吗?
支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。
@coraxai/api-client 支持 ESM 还是 CommonJS?
以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。
@coraxai/api-client 可以商用吗?
@coraxai/api-client 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。
@coraxai/api-client 的下载量有多少?
根据 npm 官方下载统计,@coraxai/api-client 在 2026/10/11 – 2026/11/09 这 30 天内被下载 6,095 次,日均约 203 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@coraxai/api-client 还在维护吗?
最新版本 2.391.0 发布于 2026/11/10(今天);至今共发布 77 个版本,其中过去 12 个月发布了 77 个;首次发布于 2026/09/03。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。