Enonic XP lib 项目 TS 类型

类型脚本定义 lib-project enonic XP 图书馆

安装

npm i --save-dev @enonic-types/lib-project

使用

要求和定制进口

来做 require 在框外工作时,必须安装并添加 @enonic-types/global 类型。 除为XP提供定义外 全球对象,例如:. log, (中文(简体) ), app, (中文(简体) ), __等,需要默认路径旁的库将返回已键入的对象.

tsconfig.json

{
  "compilerOptions": {
    "types": [
      "@enonic-types/global"
    ]
  }
}

example.ts

const {create, modify, get, list, addPermissions, removePermissions, modifyReadAccess} = require('/lib/xp/project');

更详细解释如何操作和如何输入自定义导入功能 已找到 这里。 。 。 .

ES6型导入

如果您计划使用 import 在您的代码中, 并转换它与默认 tsc TypeScript 编译器, 您需要添加正则 类型映射到您的配置.

tsconfig.json

{
  "compilerOptions": {
    "baseUrl": "./",
    "paths": {
      "/lib/xp/project": ["node_modules/@enonic-types/lib-project"]
    }
  }
}

example.ts

import {create, modify, delete as deleteProject, get, list, addPermissions, removePermissions, modifyReadAccess} from '/lib/xp/project';

设置 baseUrl 财务报告和审定财务报表 paths 将允许 tsc 以保留 JavaScript 文件中的有效路径.