@kaitify/core 0.0.1-beta.9 → 0.0.1

package/lib/extensions/task/index.d.ts

@@ -2,10 +2,25 @@ import { KNode } from '../../model';
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 获取光标所在的待办节点，如果光标不在一个待办节点内，返回null
+         */
         getTask?: () => KNode | null;
+        /**
+         * 判断光标范围内是否有待办节点
+         */
         hasTask?: () => boolean;
+        /**
+         * 光标范围内是否都是待办节点
+         */
         allTask?: () => boolean;
+        /**
+         * 设置待办
+         */
         setTask?: () => Promise<void>;
+        /**
+         * 取消待办
+         */
         unsetTask?: () => Promise<void>;
     }
 }

package/lib/extensions/text/index.d.ts

@@ -2,12 +2,33 @@ import { KNodeMarksType, KNodeStylesType } from '../../model';
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 判断光标所在文本是否具有某个样式
+         */
         isTextStyle?: (styleName: string, styleValue?: string | number) => boolean;
+        /**
+         * 判断光标所在文本是否具有某个标记
+         */
         isTextMark?: (markName: string, markValue?: string | number) => boolean;
+        /**
+         * 设置光标所在文本样式
+         */
         setTextStyle?: (styles: KNodeStylesType, updateView?: boolean) => Promise<void>;
+        /**
+         * 设置光标所在文本标记
+         */
         setTextMark?: (marks: KNodeMarksType, updateView?: boolean) => Promise<void>;
+        /**
+         * 移除光标所在文本样式
+         */
         removeTextStyle?: (styleNames?: string[], updateView?: boolean) => Promise<void>;
+        /**
+         * 移除光标所在文本标记
+         */
         removeTextMark?: (markNames?: string[], updateView?: boolean) => Promise<void>;
+        /**
+         * 清除格式
+         */
         clearFormat?: () => Promise<void>;
     }
 }

package/lib/extensions/underline/index.d.ts

@@ -1,8 +1,17 @@
 import { Extension } from '../Extension';
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 光标所在文本是否下划线
+         */
         isUnderline?: () => boolean;
+        /**
+         * 设置下划线
+         */
         setUnderline?: () => Promise<void>;
+        /**
+         * 取消下划线
+         */
         unsetUnderline?: () => Promise<void>;
     }
 }

package/lib/extensions/video/index.d.ts

@@ -18,9 +18,21 @@ export type UpdateVideoOptionType = {
 };
 declare module '../../model' {
     interface EditorCommandsType {
+        /**
+         * 获取光标所在的视频，如果光标不在一个视频内，返回null
+         */
         getVideo?: () => KNode | null;
+        /**
+         * 判断光标范围内是否有视频
+         */
         hasVideo?: () => boolean;
+        /**
+         * 插入视频
+         */
         setVideo?: (options: SetVideoOptionType) => Promise<void>;
+        /**
+         * 更新视频
+         */
         updateVideo?: (options: UpdateVideoOptionType) => Promise<void>;
     }
 }