Skip to content

Commit 02b4a5e

Browse files
JackLianliujuping
JackLian
authored and
liujuping
committed
fix(types): fix lint issues for node-children, and optimize related docs
1 parent 4ef6118 commit 02b4a5e

6 files changed

Lines changed: 391 additions & 88 deletions

File tree

‎docs/docs/api/model/node-children.md‎

Lines changed: 224 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -13,111 +13,298 @@ sidebar_position: 2
1313

1414
返回当前 children 实例所属的节点实例
1515

16+
`@type {IPublicModelNode | null}`
17+
18+
相关类型：[IPublicModelNode](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/node.ts)
19+
1620
### size
1721

1822
children 内的节点实例数
1923

20-
### isEmpty
24+
`@type {number}`
25+
26+
27+
### isEmptyNode
2128

2229
是否为空
2330

31+
`@type {boolean}`
32+
33+
**@since v1.1.0**
34+
> v1.1.0 之前请使用 `isEmpty`
35+
36+
### notEmptyNode
37+
38+
是否不为空
39+
40+
`@type {boolean}`
41+
42+
**@since v1.1.0**
43+
2444
## 方法签名
2545
### delete
46+
删除指定节点
2647

27-
delete(node: Node)
48+
```typescript
49+
/**
50+
* 删除指定节点
51+
* delete the node
52+
* @param node
53+
*/
54+
delete(node: IPublicModelNode): boolean;
55+
```
2856
29-
删除指定节点
57+
相关类型：[IPublicModelNode](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/node.ts)
3058
3159
### insert
3260
33-
insert(node: Node, at?: number | null)
34-
3561
插入一个节点
3662
37-
### indexOf
63+
```typescript
64+
/**
65+
* 删除指定节点
66+
* delete the node
67+
* @param node
68+
*/
69+
delete(node: IPublicModelNode): boolean;
70+
```
3871
39-
indexOf(node: Node)
72+
相关类型：[IPublicModelNode](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/node.ts)
73+
74+
75+
### indexOf
4076
4177
返回指定节点的下标
4278
43-
### splice
79+
```typescript
80+
/**
81+
* 返回指定节点的下标
82+
* get index of node in current children
83+
* @param node
84+
* @returns
85+
*/
86+
indexOf(node: IPublicModelNode): number;
87+
```
4488
45-
splice(start: number, deleteCount: number, node?: Node)
89+
相关类型：[IPublicModelNode](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/node.ts)
90+
91+
### splice
4692
4793
类似数组 splice 操作
4894
49-
### get
95+
```typescript
96+
/**
97+
* 类似数组 splice 操作
98+
* provide the same function with {Array.prototype.splice}
99+
* @param start
100+
* @param deleteCount
101+
* @param node
102+
*/
103+
splice(start: number, deleteCount: number, node?: IPublicModelNode): any;
104+
```
50105
51-
get(index: number)
106+
相关类型：[IPublicModelNode](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/node.ts)
107+
108+
109+
### get
52110
53111
返回指定下标的节点
54112
55-
### has
113+
```typescript
114+
/**
115+
* 返回指定下标的节点
116+
* get node with index
117+
* @param index
118+
* @returns
119+
*/
120+
get(index: number): IPublicModelNode | null;
121+
```
56122
57-
has(node: Node)
123+
相关类型：[IPublicModelNode](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/node.ts)
124+
125+
126+
### has
58127
59128
是否包含指定节点
60129
61-
### forEach
130+
```typescript
131+
/**
132+
* 是否包含指定节点
133+
* check if node exists in current children
134+
* @param node
135+
* @returns
136+
*/
137+
has(node: IPublicModelNode): boolean;
138+
```
139+
140+
相关类型：[IPublicModelNode](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/node.ts)
141+
62142
63-
forEach(fn: (node: Node, index: number) => void)
143+
### forEach
64144
65145
类似数组的 forEach
66146
67-
### map
147+
```typescript
148+
/**
149+
* 类似数组的 forEach
150+
* provide the same function with {Array.prototype.forEach}
151+
* @param fn
152+
*/
153+
forEach(fn: (node: IPublicModelNode, index: number) => void): void;
154+
155+
```
156+
157+
相关类型：[IPublicModelNode](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/node.ts)
68158
69-
map<T\>(fn: (node: Node, index: number) => T[])
159+
160+
### map
70161
71162
类似数组的 map
72163
73-
### every
164+
```typescript
165+
/**
166+
* 类似数组的 map
167+
* provide the same function with {Array.prototype.map}
168+
* @param fn
169+
*/
170+
map<T>(fn: (node: IPublicModelNode, index: number) => T[]): any[] | null;
171+
```
74172
75-
every(fn: (node: Node, index: number) => boolean)
173+
相关类型：[IPublicModelNode](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/node.ts)
174+
175+
176+
### every
76177
77178
类似数组的 every
78179
79-
### some
180+
```typescript
181+
/**
182+
* 类似数组的 every
183+
* provide the same function with {Array.prototype.every}
184+
* @param fn
185+
*/
186+
every(fn: (node: IPublicModelNode, index: number) => boolean): boolean;
187+
```
80188
81-
some(fn: (node: Node, index: number) => boolean)
189+
相关类型：[IPublicModelNode](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/node.ts)
190+
191+
192+
### some
82193
83194
类似数组的 some
84195
85-
### filter
196+
```typescript
197+
/**
198+
* 类似数组的 some
199+
* provide the same function with {Array.prototype.some}
200+
* @param fn
201+
*/
202+
some(fn: (node: IPublicModelNode, index: number) => boolean): boolean;
203+
```
204+
205+
相关类型：[IPublicModelNode](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/node.ts)
206+
86207
87-
filter(fn: (node: Node, index: number) => boolean)
208+
### filter
88209
89210
类似数组的 filter
90211
91-
### find
212+
```typescript
213+
/**
214+
* 类似数组的 filter
215+
* provide the same function with {Array.prototype.filter}
216+
* @param fn
217+
*/
218+
filter(fn: (node: IPublicModelNode, index: number) => boolean): any;
219+
```
220+
221+
相关类型：[IPublicModelNode](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/node.ts)
222+
92223
93-
find(fn: (node: Node, index: number) => boolean)
224+
### find
94225
95226
类似数组的 find
96227
97-
### reduce
228+
```typescript
229+
/**
230+
* 类似数组的 find
231+
* provide the same function with {Array.prototype.find}
232+
* @param fn
233+
*/
234+
find(fn: (node: IPublicModelNode, index: number) => boolean): IPublicModelNode | null;
235+
```
236+
237+
相关类型：[IPublicModelNode](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/node.ts)
98238
99-
reduce(fn: (acc: any, cur: Node) => any, initialValue: any)
239+
240+
### reduce
100241
101242
类似数组的 reduce
102243
103-
### importSchema
244+
```typescript
245+
/**
246+
* 类似数组的 reduce
247+
* provide the same function with {Array.prototype.reduce}
248+
* @param fn
249+
*/
250+
reduce(fn: (acc: any, cur: IPublicModelNode) => any, initialValue: any): void;
251+
```
252+
253+
相关类型：[IPublicModelNode](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/node.ts)
104254
105-
importSchema(data?: NodeData | NodeData[])
255+
256+
### importSchema
106257
107258
导入 schema
108259
109-
### exportSchema
260+
```typescript
261+
/**
262+
* 导入 schema
263+
* import schema
264+
* @param data
265+
*/
266+
importSchema(data?: IPublicTypeNodeData | IPublicTypeNodeData[]): void;
267+
```
268+
269+
相关类型：[IPublicTypeNodeData](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/node-data.ts)
110270
111-
exportSchema(stage: IPulicEnumTransformStage = IPulicEnumTransformStage.Render)
112271
272+
### exportSchema
113273
导出 schema
114274
275+
```typescript
276+
/**
277+
* 导出 schema
278+
* export schema
279+
* @param stage
280+
*/
281+
exportSchema(stage: IPublicEnumTransformStage): IPublicTypeNodeSchema;
282+
```
283+
284+
相关类型：
285+
- [IPublicEnumTransformStage](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/enum/transform-stage.ts)
286+
- [IPublicTypeNodeSchema](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/node-schema.ts)
287+
288+
115289
### mergeChildren
116290
117-
mergeChildren(
118-
remover: (node: Node, idx: number) => boolean,
119-
adder: (children: Node[]) => any,
120-
sorter: (firstNode: Node, secondNode: Node) => number,
121-
)
291+
执行新增、删除、排序等操作
122292
123-
执行新增、删除、排序等操作
293+
```typescript
294+
/**
295+
* 执行新增、删除、排序等操作
296+
* excute remove/add/sort operations
297+
* @param remover
298+
* @param adder
299+
* @param sorter
300+
*/
301+
mergeChildren(
302+
remover: (node: IPublicModelNode, idx: number) => boolean,
303+
adder: (children: IPublicModelNode[]) => IPublicTypeNodeData[] | null,
304+
sorter: (firstNode: IPublicModelNode, secondNode: IPublicModelNode) => number
305+
): any;
306+
```
307+
308+
相关类型：
309+
- [IPublicModelNode](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/node.ts)
310+
- [IPublicTypeNodeData](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/node-data.ts)

0 commit comments

Comments
 (0)