@karlroigus/api-contracts

中文文档
1.0.19发布于 2026/11/01MITTypeScriptCommonJS零依赖

Shared TypeScript types for the Enchanté webstore API

原始使用文档
文档目录3 节
  1. Install
  2. Usage
  3. Development

@karlroigus/api-contracts

Shared TypeScript types for the Enchanté webstore API. Used by both the Express backend and the React frontend.

Install

npm install @karlroigus/api-contracts

Usage

import type { Product, Order, CreatePaymentSessionRequest } from '@karlroigus/api-contracts';

Development

After changing types in src/index.ts:

npm version patch
npm publish --access public

Then update consumers:

cd api && npm install @karlroigus/api-contracts@latest
cd frontend && npm install @karlroigus/api-contracts@latest

版本与发布记录

@karlroigus/api-contracts 共发布 20 个版本,首次发布于 2026/10/17;过去 12 个月发布了 20 个版本。

版本发布日期距今
1.0.19latest2026/11/012 天前
1.0.182026/11/012 天前
1.0.172026/11/012 天前
1.0.162026/11/012 天前
1.0.152026/11/012 天前
1.0.142026/10/313 天前

关于 @karlroigus/api-contracts 的常见问题

@karlroigus/api-contracts 是什么?

共享的TypeScript类型,用于enchanted webstore API

如何安装 @karlroigus/api-contracts?

在项目目录运行 npm install @karlroigus/api-contracts,或使用 pnpm add / yarn add / bun add。

@karlroigus/api-contracts 支持 TypeScript 吗?

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

@karlroigus/api-contracts 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@karlroigus/api-contracts 可以商用吗?

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

@karlroigus/api-contracts 还在维护吗?

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