Enonic XP 核心 TS 类型

由库共享并代表核心的脚本定义 数据结构.

安装

npm i --save-dev @enonic-types/core

使用

无需将这种依赖性纳入您的项目中 库输出相关的核心类型,例如内容库输出 Content 类型.

所有核心类型均可使用ES6型导入:

import type {Content} from '@enonic-types/core';

内容

Content 包含 x 财产,这是一个非常特殊的 XpXData 类型.

XpXData 是一个接口,它被添加到全球范围,所以可以 使用 声明合并。 。 。 . 这使得您可以在您的工程中设置 XData 的形状, 只需通过 声明 XpXData 像这样:

declare global {
    interface XpXData {
        'com-mysite-app': {
            metadata: {
                metaTagTitle: string;
                metaTagImageId: string;
            }
        }
    }
}

其他类型

Content 是一种包含结合和地图的复杂类型,不出口,但在开发过程中可能需要。 实际上,这些类型很容易从 Content 本身:

import type {Content} from '@enonic-types/core';

type Attachments = Content['attachments'];

type ContentInheritType = Content['inherit'];

type Workflow = Content['workflow'];