npm 包 @2sic.com/2sxc-typings 使用教程

介绍

@2sic.com/2sxc-typings 是一个 TypeScript 类型声明插件，它为 2sxc 应用程序提供了类型安全的 API，值得一提的是，该插件只支持 TypeScript 开发。随着 TypeScript 的普及，使用该插件可以提高编码效率和代码质量，值得推广使用。

安装

使用 npm 安装最新版：

npm install @2sic.com/2sxc-typings

使用

导入声明文件

在需要使用 2sxc 的 TypeScript 文件中，使用如下语句导入声明文件：

import { SxcInstance, EntityInfos } from "@2sic.com/2sxc-typings";

现在就可以开始使用 2sxc 的类型安全 API 编写代码了。

示例

以下示例演示了如何通过 SxcInstance 获取 Entity Infos：

import { SxcInstance, EntityInfos } from "@2sic.com/2sxc-typings";

const sxc: SxcInstance = ...; // 初始化 SxcInstance
const entityInfos: Promise<EntityInfos> = sxc.webApi.get("app/auto/entityinfos"); // 获取 Entity Infos

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/130846