Skip to content

@vtj / Modules / core

Module: core

Table of contents

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

ApiMethod

Ƭ ApiMethod: "get" | "post" | "put" | "delete" | "patch" | "jsonp"

请求方法

Defined in

packages/core/src/protocols/schemas/dataSource.ts:11


BlockPropDataType

Ƭ BlockPropDataType: "String" | "Number" | "Boolean" | "Array" | "Object" | "Function" | "Date"

Defined in

packages/core/src/protocols/schemas/block.ts:129


BlockState

Ƭ BlockState: Record<string, JSONValue | JSExpression | JSFunction>

组件状态描述

Defined in

packages/core/src/protocols/schemas/block.ts:109


DataSourceType

Ƭ DataSourceType: "api" | "cube" | "meta"

数据源类型,目前仅实现api类型

Defined in

packages/core/src/protocols/schemas/dataSource.ts:6


DataType

Ƭ DataType: "String" | "Boolean" | "Number" | "Date" | "Object" | "Array" | "Function"

数据类型

Defined in

packages/core/src/protocols/shared.ts:46


DropPosition

Ƭ DropPosition: "left" | "right" | "top" | "bottom" | "inner"

节点放置位置

Defined in

packages/core/src/models/block.ts:20


Emitter

Ƭ Emitter: Object

Type declaration

NameType
all{ clear: () => void }
all.clear[object Object]
emit(type: string, ...args: any[]) => void
off(type: string, listener: (...args: any[]) => void) => void
on(type: string, listener: (...args: any[]) => void) => void

Defined in

packages/core/src/tools/emitter.ts:38


FileType

Ƭ FileType: "block" | "page"

文件类型

Defined in

packages/core/src/protocols/schemas/file.ts:6


JSONArray

Ƭ JSONArray: JSONValue[]

json 数组

Defined in

packages/core/src/protocols/shared.ts:16


JSONValue

Ƭ JSONValue: boolean | string | number | null | undefined | JSONArray | JSONObject

json属性值

Defined in

packages/core/src/protocols/shared.ts:4


ModelEventType

Ƭ ModelEventType: "create" | "update" | "delete" | "clone" | "clear" | "load" | "publish"

Defined in

packages/core/src/tools/emitter.ts:47


NodeChildren

Ƭ NodeChildren: string | JSExpression | NodeSchema[]

子组件描述

Defined in

packages/core/src/protocols/schemas/node.ts:120


NodeEvents

Ƭ NodeEvents: Record<string, NodeEvent>

Defined in

packages/core/src/protocols/schemas/node.ts:115


NodeFrom

Ƭ NodeFrom: string | NodeFromSchema | NodeFromUrlSchema | NodeFromPlugin

组件来源, 字符串是依赖包名

Defined in

packages/core/src/protocols/schemas/node.ts:61


NodeModifiers

Ƭ NodeModifiers: Record<string, boolean>

事件/指令修饰符

Defined in

packages/core/src/protocols/schemas/node.ts:161

Variables

BUILT_IN_COMPONENTS

Const BUILT_IN_COMPONENTS: Record<string, string[]>

内置组件

Defined in

packages/core/src/constants.ts:32


BUILT_IN_LIBRARAY_MAP

Const BUILT_IN_LIBRARAY_MAP: Record<string, string>

内置类库包名和导出名映射

Defined in

packages/core/src/constants.ts:24


BUILT_IN_MATERIALS

Const BUILT_IN_MATERIALS: string[]

内置物料

Defined in

packages/core/src/constants.ts:19


BUILT_IN_NAME

Const BUILT_IN_NAME: "BuiltIn"

内置物料名

Defined in

packages/core/src/constants.ts:4


BUILT_IN_TAGS

Const BUILT_IN_TAGS: string[]

Defined in

packages/core/src/constants.ts:43


BUILT_IN_VUE

Const BUILT_IN_VUE: "VueMaterial"

内置 vue 组件物料名

Defined in

packages/core/src/constants.ts:9


BUILT_IN_VUE_ROUTER

Const BUILT_IN_VUE_ROUTER: "VueRouterMaterial"

内置 vue-router 组件物料名

Defined in

packages/core/src/constants.ts:14


EVENT_BLOCK_CHANGE

Const EVENT_BLOCK_CHANGE: "EVENT_BLOCK_CHANGE"

区块发生改变时触发的事件名称

Defined in

packages/core/src/models/block.ts:25


EVENT_HISTORY_CHANGE

Const EVENT_HISTORY_CHANGE: "EVENT_HISTORY_CHANGE"

Defined in

packages/core/src/models/history.ts:9


EVENT_HISTORY_LOAD

Const EVENT_HISTORY_LOAD: "EVENT_HISTORY_LOAD"

Defined in

packages/core/src/models/history.ts:10


EVENT_NODE_CHANGE

Const EVENT_NODE_CHANGE: "EVENT_NODE_CHANGE"

节点发生改变时触发的事件名称

Defined in

packages/core/src/models/node.ts:20


EVENT_PROJECT_ACTIVED

Const EVENT_PROJECT_ACTIVED: "EVENT_PROJECT_ACTIVED"

打开/关闭文件时触发事件

Defined in

packages/core/src/models/project.ts:26


EVENT_PROJECT_APIS_CHANGE

Const EVENT_PROJECT_APIS_CHANGE: "EVENT_PROJECT_APIS_CHANGE"

API更新

Defined in

packages/core/src/models/project.ts:46


EVENT_PROJECT_BLOCKS_CHANGE

Const EVENT_PROJECT_BLOCKS_CHANGE: "EVENT_PROJECT_BLOCKS_CHANGE"

区块文件更新

Defined in

packages/core/src/models/project.ts:41


EVENT_PROJECT_CHANGE

Const EVENT_PROJECT_CHANGE: "EVENT_PROJECT_CHANGE"

项目信息更新时触发事件

Defined in

packages/core/src/models/project.ts:22


EVENT_PROJECT_DEPS_CHANGE

Const EVENT_PROJECT_DEPS_CHANGE: "EVENT_PROJECT_DEPS_CHANGE"

依赖更新时触发

Defined in

packages/core/src/models/project.ts:31


EVENT_PROJECT_FILE_PUBLISH

Const EVENT_PROJECT_FILE_PUBLISH: "EVENT_PROJECT_FILE_PUBLISH"

项目文件发布

Defined in

packages/core/src/models/project.ts:56


EVENT_PROJECT_PAGES_CHANGE

Const EVENT_PROJECT_PAGES_CHANGE: "EVENT_PROJECT_PAGES_CHANGE"

页面文件更新

Defined in

packages/core/src/models/project.ts:36


EVENT_PROJECT_PUBLISH

Const EVENT_PROJECT_PUBLISH: "EVENT_PROJECT_PUBLISH"

项目发布

Defined in

packages/core/src/models/project.ts:51


VTJ_CORE_VERSION

Const VTJ_CORE_VERSION: "0.8.8"

! Copyright (c) 2024, VTJ.PRO All rights reserved.

Name

@vtj/core

Author

CHC chenhuachun1549@dingtalk.com

Version

0.8.8

License

MIT License

Defined in

packages/core/src/version.ts:8


emitter

Const emitter: Emitter<Events>

Defined in

packages/core/src/tools/emitter.ts:36

Functions

cloneDsl

cloneDsl(dsl): NodeSchema

Parameters

NameType
dslNodeSchema

Returns

NodeSchema

Defined in

packages/core/src/tools/util.ts:21


createNodeFrom

createNodeFrom(file): NodeFrom

Parameters

NameType
fileBlockFile

Returns

NodeFrom

Defined in

packages/core/src/tools/util.ts:29


isBlock

isBlock(value): value is BlockModel

Parameters

NameType
valueunknown

Returns

value is BlockModel

Defined in

packages/core/src/tools/util.ts:9


isBlockSchema

isBlockSchema(value): value is BlockSchema

Parameters

NameType
valueunknown

Returns

value is BlockSchema

Defined in

packages/core/src/tools/util.ts:17


isNode

isNode(value): value is BlockModel

Parameters

NameType
valueunknown

Returns

value is BlockModel

Defined in

packages/core/src/tools/util.ts:13

Released under the MIT License.