@waline/client 2.0.0 → 2.0.3

package/dist/waline.cjs.d.ts

@@ -319,7 +319,7 @@ interface WalineInitOptions extends Omit<WalineProps, 'path'> {
      */
     path?: string;
 }
-declare type WalineAbort = (reson: any) => void;
+declare type WalineAbort = (reason?: any) => void;
 
 declare const getMeta: (meta: WalineMeta[]) => WalineMeta[];
 declare const defaultLang = "zh-CN";
@@ -421,15 +421,40 @@ declare const pageviewCount: ({ serverURL, path, selector, update, }: WalinePage
 
 declare const version: string;
 
-interface RecentCommentsOptions {
+interface WalineRecentCommentsOptions {
+    /**
+     * Waline 服务端地址
+     *
+     * Waline serverURL
+     */
     serverURL: string;
+    /**
+     * 获取最新评论的数量
+     *
+     * fetch number of latest comments
+     */
     count: number;
+    /**
+     * 需要挂载的元素
+     *
+     * Element to be mounted
+     */
     el?: string | HTMLElement;
 }
-interface RecentCommentsResult {
+interface WalineRecentCommentsResult {
+    /**
+     * 评论数据
+     *
+     * Comment Data
+     */
     comments: WalineComment[];
+    /**
+     * 取消挂载挂件
+     *
+     * Umount widget
+     */
     destroy: () => void;
 }
-declare const RecentComments: ({ el, serverURL, count, }: RecentCommentsOptions) => Promise<RecentCommentsResult>;
+declare const RecentComments: ({ el, serverURL, count, }: WalineRecentCommentsOptions) => Promise<WalineRecentCommentsResult>;
 
-export { Locales, RecentComments, RecentCommentsOptions, RecentCommentsResult, WalineAbort, WalineComment, WalineCommentCountOptions, WalineCommentData, WalineEmojiInfo, WalineEmojiMaps, WalineHighlighter, WalineImageUploader, WalineInitOptions, WalineInstance, WalineLocale, WalineMeta, WalinePageviewCountOptions, WalineProps, WalineTexRenderer, commentCount, defaultLang, defaultTexRenderer, defaultUploadImage, getMeta, init, locales, pageviewCount, version };
+export { Locales, RecentComments, WalineAbort, WalineComment, WalineCommentCountOptions, WalineCommentData, WalineEmojiInfo, WalineEmojiMaps, WalineHighlighter, WalineImageUploader, WalineInitOptions, WalineInstance, WalineLocale, WalineMeta, WalinePageviewCountOptions, WalineProps, WalineRecentCommentsOptions, WalineRecentCommentsResult, WalineTexRenderer, commentCount, defaultLang, defaultTexRenderer, defaultUploadImage, getMeta, init, locales, pageviewCount, version };