@waline/client 3.10.0 → 3.11.0

package/dist/waline.d.ts

@@ -688,14 +688,40 @@ interface WalineUserListResult {
 }
 declare const UserList: ({ el, serverURL, count, locale, lang, mode, }: WalineUserListOptions) => Promise<WalineUserListResult>;
 
+/**
+ * Options for the star rating widget.
+ */
 interface WalineStarOptions {
-    el: string | HTMLElement;
+    /**
+     * Element or CSS selector on which to mount the widget.
+     */
+    el?: string | HTMLElement;
+    /**
+     * Path identifying the current page or article.
+     */
     path: string;
-    lang: string;
+    /**
+     * Language code used by the widget, such as `en` or `zh-CN`.
+     */
+    lang?: string;
+    /**
+     * Waline server URL.
+     */
     serverURL: string;
+    /**
+     * Callback invoked after the user submits a rating.
+     *
+     * @param score The score selected by the user.
+     */
     onRate?: (score: number) => void;
 }
+/**
+ * Star widget result.
+ */
 interface WalineStarResult {
+    /**
+     * Destroy star widget instance.
+     */
     destroy: () => void;
 }
 declare const Star: ({ el, path, lang, serverURL, onRate, }: WalineStarOptions) => WalineStarResult;