koishi-plugin-nezha-api
Version:
48 lines (47 loc) • 5.83 kB
TypeScript
import { Context, Logger, Schema } from 'koishi';
declare module 'koishi' {
interface Tables {
nezha_site: NezhaSite;
nezha_site_v1: NezhaSiteV1;
}
}
export interface NezhaSite {
userId: number;
url: string;
token: string;
}
declare const ValidTypes: readonly ["v0", "v1", "komari"];
type SiteType = typeof ValidTypes[number];
export interface NezhaSiteV1 {
userId: number;
type: SiteType;
url: string;
token: string;
username: string;
password: string;
}
export declare const name = "nezha-api";
export declare const inject: {
required: string[];
optional: string[];
};
export declare const logger: Logger;
export interface Config {
responseTimeout: number;
showChangedData: boolean;
channelRecall: boolean;
recallTime: number;
aliveThreshold: number;
alertNotify: {
enable: boolean;
path: string;
bodyContent: {
Nezha: string;
Komari: string;
};
};
}
export declare const Config: Schema<Config>;
export declare const usage = "\n## \u4F7F\u7528\u8BF4\u660E\n\n### \u6307\u4EE4\uFF1Anezha\n* \u57FA\u672C\u8BED\u6CD5\uFF1A`nezha`\n* \u6307\u4EE4\u529F\u80FD\uFF1A\u8F93\u51FA\u63D2\u4EF6\u7684\u7B80\u6613\u4FE1\u606F\n\n### \u6307\u4EE4\uFF1Anezha help\n* \u57FA\u672C\u8BED\u6CD5\uFF1A`nezha help`\n* \u6307\u4EE4\u529F\u80FD\uFF1A\u7B49\u4EF7\u4E8E `help nezha`\n\n### \u6307\u4EE4\uFF1Anezha add\n* \u57FA\u672C\u8BED\u6CD5\uFF1A`nezha add <type:string> [url:string] [input1:string] [input2:string]`\n* \u6307\u4EE4\u529F\u80FD\uFF1A\u6DFB\u52A0 `NezhaV0` / `NezhaV1` / `Komari` \u7AD9\u70B9\u7684 `url` \u548C `token` / `username` & `password` \u81F3\u6570\u636E\u5E93\uFF0C\u8BF7\u786E\u4FDD `url` \u548C `token` / `username` & `password` \u5747\u6709\u6548\n* \u4F7F\u7528\u9650\u5236\uFF1A**\u4EC5\u79C1\u804A\u53EF\u7528**\uFF0C\u652F\u6301\u4EA4\u4E92\u5F0F\u8F93\u5165\n\n### \u6307\u4EE4\uFF1Anezha delete/del\n* \u57FA\u672C\u8BED\u6CD5\uFF1A`nezha del <type:string>`\n* \u6307\u4EE4\u529F\u80FD\uFF1A\u5220\u9664\u5DF2\u4FDD\u5B58\u7684\u7AD9\u70B9\u6570\u636E\n* \u4F7F\u7528\u9650\u5236\uFF1A**\u4EC5\u79C1\u804A\u53EF\u7528**\uFF0C\u652F\u6301\u4EA4\u4E92\u5F0F\u8F93\u5165\n\n### \u6307\u4EE4\uFF1Anezha url\n* \u57FA\u672C\u8BED\u6CD5\uFF1A`nezha url <type:string> [url:string]`\n* \u6307\u4EE4\u529F\u80FD\uFF1A\u4FEE\u6539\u6570\u636E\u5E93\u4E2D\u8BB0\u5F55\u7684\u6307\u5B9A\u7C7B\u578B\u7684\u7AD9\u70B9 `url` \uFF0C\u8BF7\u786E\u4FDD\u5DF2\u4F7F\u7528 `nezha add` \u6DFB\u52A0\u8FC7\u6570\u636E\n* \u4F7F\u7528\u9650\u5236\uFF1A**\u4EC5\u79C1\u804A\u53EF\u7528**\uFF0C\u652F\u6301\u4EA4\u4E92\u5F0F\u8F93\u5165\n\n### \u6307\u4EE4\uFF1Anezha token\n* \u57FA\u672C\u8BED\u6CD5\uFF1A`nezha url [token:string]`\n* \u6307\u4EE4\u529F\u80FD\uFF1A\u4FEE\u6539\u6570\u636E\u5E93\u4E2D\u8BB0\u5F55 `NezhaV0` \u7684\u7AD9\u70B9 `token` \uFF0C\u8BF7\u786E\u4FDD\u5DF2\u4F7F\u7528 `nezha add` \u6DFB\u52A0\u8FC7\u6570\u636E\n* \u4F7F\u7528\u9650\u5236\uFF1A**\u4EC5\u79C1\u804A\u53EF\u7528**\uFF0C\u652F\u6301\u4EA4\u4E92\u5F0F\u8F93\u5165\n\n### \u6307\u4EE4\uFF1Anezha info\n* \u57FA\u672C\u8BED\u6CD5\uFF1A`nezha info`\n* \u6307\u4EE4\u529F\u80FD\uFF1A\u67E5\u770B\u6570\u636E\u5E93\u4E2D\u8BB0\u5F55\u7684\u6240\u6709\u7AD9\u70B9 `url` \u548C `token` / `username` & `password`\n* \u4F7F\u7528\u9650\u5236\uFF1A**\u4EC5\u79C1\u804A\u53EF\u7528**\n\n### \u6307\u4EE4\uFF1Anezha all\n* \u57FA\u672C\u8BED\u6CD5\uFF1A`nezha all [type:string] [tag:string]`\n* \u6307\u4EE4\u529F\u80FD\uFF1A\u83B7\u53D6 `tag` \u5206\u7EC4\u4E0B\u6240\u6709\u670D\u52A1\u5668\u7684\u7EDF\u8BA1\u6570\u636E\u6458\u8981\uFF0C\u7559\u7A7A\u5219\u8FD4\u56DE\u6240\u6709\u6570\u636E\uFF0C\u5F53\u4E14\u4EC5\u5F53 `tag` \u4E3A `untagged` \u65F6\u8FD4\u56DE\u672A\u5206\u7EC4\u7684\u6570\u636E\n* \u4F7F\u7528\u9650\u5236\uFF1A`tag` \u53C2\u6570\u4EC5\u652F\u6301 `NezhaV0` \u7AD9\u70B9\n\n### \u6307\u4EE4\uFF1Anezha list\n* \u57FA\u672C\u8BED\u6CD5\uFF1A`nezha list [type:string] [tag:string]`\n* \u6307\u4EE4\u529F\u80FD\uFF1A\u83B7\u53D6 `tag` \u5206\u7EC4\u4E0B\u6240\u6709\u670D\u52A1\u5668\u7684\u72B6\u6001\u4FE1\u606F\u6458\u8981\uFF0C\u7559\u7A7A\u5219\u8FD4\u56DE\u6240\u6709\u6570\u636E\uFF0C\u5F53\u4E14\u4EC5\u5F53 `tag` \u4E3A `untagged` \u65F6\u8FD4\u56DE\u672A\u5206\u7EC4\u7684\u6570\u636E\n* \u4F7F\u7528\u9650\u5236\uFF1A`tag` \u53C2\u6570\u4EC5\u652F\u6301 `NezhaV0` \u7AD9\u70B9\n\n### \u6307\u4EE4\uFF1Anezha id\n* \u57FA\u672C\u8BED\u6CD5\uFF1A`nezha id <type:string> [id:number]`\n* \u6307\u4EE4\u529F\u80FD\uFF1A\u83B7\u53D6ID\u4E3A `id` \u7684\u670D\u52A1\u5668\u8BE6\u7EC6\u4FE1\u606F\n* \u4F7F\u7528\u9650\u5236\uFF1A\u4EC5\u652F\u6301 `NezhaV0` \u548C `NezhaV1` \u7AD9\u70B9\uFF0C\u652F\u6301\u4EA4\u4E92\u5F0F\u8F93\u5165\n\n### \u6307\u4EE4\uFF1Anezha uuid\n* \u57FA\u672C\u8BED\u6CD5\uFF1A`nezha uuid [uuid:string]`\n* \u6307\u4EE4\u529F\u80FD\uFF1A\u83B7\u53D6UUID\u4E3A `uuid` \u7684\u670D\u52A1\u5668\u8BE6\u7EC6\u4FE1\u606F\n* \u4F7F\u7528\u9650\u5236\uFF1A\u4EC5\u652F\u6301 `Komari` \u7AD9\u70B9\uFF0C\u652F\u6301\u4EA4\u4E92\u5F0F\u8F93\u5165\n\n### \u6307\u4EE4\uFF1Anezha search\n* \u57FA\u672C\u8BED\u6CD5\uFF1A`nezha search <name:string>`\n* \u6307\u4EE4\u529F\u80FD\uFF1A\u641C\u7D22\u6240\u6709\u7AD9\u70B9\u4E2D\u540D\u79F0\u5305\u542B\u5173\u952E\u5B57 `name` \u7684\u670D\u52A1\u5668\u72B6\u6001\u4FE1\u606F\u6458\u8981\n\n### \u6307\u4EE4\uFF1Anezha notify\n* \u57FA\u672C\u8BED\u6CD5\uFF1A`nezha notify <type:string>`\n* \u6307\u4EE4\u529F\u80FD\uFF1A**\u9700\u8981\u516C\u7F51\u90E8\u7F72**\uFF0C\u83B7\u53D6\u4E0D\u540C\u7AD9\u70B9\u7684\u544A\u8B66\u901A\u77E5\u8BF7\u6C42\u7684\u90E8\u5206\u53C2\u6570\uFF0C\u4FBF\u4E8E\u65B0\u589E\u901A\u77E5\u65B9\u5F0F\n";
export declare function apply(ctx: Context, config: Config): void;
export {};