root/clash-verge-rev
1
0
Fork 0
mirror of https://github.com/clash-verge-rev/clash-verge-rev.git synced 2026-01-28 07:14:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add JSDoc for showNotice API

Browse Source
This commit is contained in:
Slinetrac
2025-12-06 11:16:26 +08:00
parent 2ca8e6716d
commit 5797bb7f8c
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/services/noticeService.ts
View File

@@ -311,6 +311,17 @@ const baseShowNotice = (
return id;
};
/**
* Shows a global notice; `showNotice.success / error / info` are the usual entry points.
*
* - `message`: i18n key string, `{ key, params }`, ReactNode, Error/any value (message is extracted)
* - `extras` parsed left-to-right: first plain object is i18n params; next value is raw payload; first number overrides duration (ms, 0 = persistent; defaults: success 3000 / info 5000 / error 8000)
* - Returns a notice id for manual closing via `hideNotice(id)`
*
* @example showNotice.success("profiles.page.feedback.notifications.batchDeleted");
* @example showNotice.error(err); // pass an Error directly
* @example showNotice.error("profiles.page.feedback.errors.invalidUrl", { url }, 4000);
*/
export const showNotice: ShowNotice = Object.assign(baseShowNotice, {
success: (message: NoticeContent, ...extras: NoticeExtra[]) =>
baseShowNotice("success", message, ...extras),