@waline/client 2.0.0-alpha.4 → 2.0.0

package/dist/waline.cjs.d.ts

@@ -319,6 +319,7 @@ interface WalineInitOptions extends Omit<WalineProps, 'path'> {
      */
     path?: string;
 }
+declare type WalineAbort = (reson: any) => void;
 
 declare const getMeta: (meta: WalineMeta[]) => WalineMeta[];
 declare const defaultLang = "zh-CN";
@@ -328,49 +329,95 @@ declare const defaultTexRenderer: (blockMode: boolean) => string;
 declare type Locales = Record<string, WalineLocale>;
 declare const locales: Locales;
 
-interface CommentCountOptions {
+interface WalineCommentCountOptions {
+    /**
+     * Waline 服务端地址
+     *
+     * Waline server url
+     */
     serverURL: string;
+    /**
+     * 评论数 CSS 选择器
+     *
+     * Commment count CSS selector
+     *
+     * @default '.waline-comment-count'
+     */
     selector?: string;
+    /**
+     * 需要获取的默认路径
+     *
+     * Path to be fetched by default
+     *
+     * @default window.location.pathname
+     */
     path?: string;
 }
-declare const commentCount: ({ serverURL, path, selector, }: CommentCountOptions) => (reason?: unknown) => void;
+declare const commentCount: ({ serverURL, path, selector, }: WalineCommentCountOptions) => WalineAbort;
 
 interface WalineInstance {
+    /**
+     * Waline 被挂载到的元素
+     *
+     * @description 当通过 `el: null` 初始化，值为 `null`
+     *
+     * Element where Waline is mounted
+     *
+     * @description when initialized with `el: null`, it will be `null`
+     */
     el: HTMLElement | null;
-    update: (newOptions: Partial<WalineProps>) => void;
+    /**
+     * 更新 Waline 实例
+     *
+     * @description 只要不设置`path` 选项，更新时它就会被重置为 `windows.location.pathname`
+     *
+     * Update Waline instance
+     *
+     * @description when not setting `path` option, it will be reset to `window.location.pathname`
+     */
+    update: (newOptions: Partial<Omit<WalineInitOptions, 'el'>>) => void;
+    /**
+     * 取消挂载并摧毁 Waline 实例
+     *
+     * Unmount and destroy Waline instance
+     */
     destroy: () => void;
 }
 declare const init: ({ el, path, comment, pageview, ...initProps }: WalineInitOptions) => WalineInstance | null;
 
-interface VisitorCountOptions {
+interface WalinePageviewCountOptions {
     /**
-     * Waline server url
-     *
      * Waline 服务端地址
+     *
+     * Waline server url
      */
     serverURL: string;
     /**
-     * Path to be fetched and updated
+     * 浏览量 CSS 选择器
      *
-     * 需要更新和获取的路径
+     * Pageview CSS selector
      *
-     * @default window.location.pathname
-     */
-    path?: string;
-    /**
      * @default '.waline-pageview-count'
      */
     selector?: string;
     /**
-     * Whether update pageviews when fetching path result
+     * 需要更新和获取的路径
      *
+     * Path to be fetched and updated
+     *
+     * @default window.location.pathname
+     */
+    path?: string;
+    /**
      * 是否在查询时更新 path 的浏览量
      *
+     * Whether update pageviews when fetching path result
+     *
      * @default true
      */
     update?: boolean;
 }
-declare const pageviewCount: ({ serverURL, path, selector, update, }: VisitorCountOptions) => (reason?: unknown) => void;
+declare const pageviewCount: ({ serverURL, path, selector, update, }: WalinePageviewCountOptions) => WalineAbort;
 
 declare const version: string;
 
@@ -385,4 +432,4 @@ interface RecentCommentsResult {
 }
 declare const RecentComments: ({ el, serverURL, count, }: RecentCommentsOptions) => Promise<RecentCommentsResult>;
 
-export { CommentCountOptions, Locales, RecentComments, RecentCommentsOptions, RecentCommentsResult, VisitorCountOptions, WalineComment, WalineCommentData, WalineEmojiInfo, WalineEmojiMaps, WalineHighlighter, WalineImageUploader, WalineInitOptions, WalineInstance, WalineLocale, WalineMeta, WalineProps, WalineTexRenderer, commentCount, defaultLang, defaultTexRenderer, defaultUploadImage, getMeta, init, locales, pageviewCount, version };
+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 };