diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 0ff6b5a..09441ca 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -20,7 +20,7 @@ jobs:
- uses: actions/setup-node@v4
with:
node-version: latest
- - run: npm install #install 过程中dist就已经被构建好了
+ - run: npm install --force #install 过程中dist就已经被构建好了
- name: add all
run: git add -A
diff --git a/.github/workflows/static-page.yml b/.github/workflows/static-page.yml
index 4d414f1..8691d4e 100644
--- a/.github/workflows/static-page.yml
+++ b/.github/workflows/static-page.yml
@@ -43,7 +43,7 @@ jobs:
- uses: actions/setup-node@v4
with:
node-version: latest
- - run: npm install
+ - run: npm install --force
- run: npm run build:doc
- run: mv dist/* .github/pages
diff --git a/dev/build/docs-language-sidebar.mjs b/dev/build/docs-language-sidebar.mjs
index b4a84ba..a00f0f2 100644
--- a/dev/build/docs-language-sidebar.mjs
+++ b/dev/build/docs-language-sidebar.mjs
@@ -4,16 +4,16 @@ import path from "path"
const template = `
`
/** @param {td.Application} app */
export function load(app) {
app.renderer.hooks.on("pageSidebar.begin", (context) => {
- const language = app.options.getValue("htmlLang")
+ const language = app.options.getValue("lang")
const root = path.posix.join(context.relativeURL("./"), "..")
const html = template
diff --git a/package.json b/package.json
index 0e42767..ce8fa6b 100644
--- a/package.json
+++ b/package.json
@@ -92,7 +92,7 @@
"rollup": "^4.18.0",
"rollup-plugin-dts": "^6.1.1",
"terser": "^5.31.1",
- "typedoc": "^0.25.13",
+ "typedoc": "^0.26.0-beta.4",
"typedoc-plugin-missing-exports": "^2.3.0",
"uglify-js": "^3.18.0"
},
diff --git a/src/.decls/cn/tsconfig.json b/src/.decls/cn/tsconfig.json
index a33828a..4068476 100644
--- a/src/.decls/cn/tsconfig.json
+++ b/src/.decls/cn/tsconfig.json
@@ -13,8 +13,13 @@
"entryPoints": [
"jsstp.d.ts"
],
- "htmlLang": "zh-CN",
+ "lang": "zh",
"out": "../../../.github/pages/doc/CN",
"readme": "../../../docs/README_CN.md",
+ "locales": {
+ "zh": {
+ "tag_alias": "別名"
+ }
+ }
}
}
diff --git a/src/.decls/cn/types/jsstp_t.d.ts b/src/.decls/cn/types/jsstp_t.d.ts
index ca663be..3b9e47a 100644
--- a/src/.decls/cn/types/jsstp_t.d.ts
+++ b/src/.decls/cn/types/jsstp_t.d.ts
@@ -8,7 +8,7 @@ import type { base_sstp_content_t, common_communicate_sstp_content_t, common_eve
/**
* sstp方法调用器
- * @group callers
+ * @group 调用器
*/
interface method_caller {
(...args: Rest): Promise;
@@ -19,7 +19,7 @@ interface method_caller {
/**
* 可以通过成员访问扩充指定key值的拓展调用器
- * @group callers
+ * @group 调用器
*/
interface base_keyed_method_caller extends method_caller {
/**
@@ -29,7 +29,7 @@ interface base_keyed_method_caller extends base_keyed_method_caller {
/**
@@ -53,7 +53,7 @@ interface simple_keyed_method_caller extends base_keyed_method_caller<
* "Reference0": 123,
* "Reference1": "abc"
* });
- * @group callers
+ * @group 调用器
*/
interface event_caller extends base_keyed_method_caller {
/**
@@ -72,7 +72,7 @@ interface event_caller extends base_keyed_method_caller {
* "Reference0": 123,
* "Reference1": "abc"
* });
- * @group callers
+ * @group 调用器
*/
interface simple_event_caller extends simple_keyed_method_caller {
/**
@@ -95,7 +95,7 @@ interface simple_event_caller extends simple_keyed_method_caller {
* "Reference0": "abc",
* "Reference1": "def"
* });
- * @group callers
+ * @group 调用器
*/
interface command_caller extends base_keyed_method_caller {
/**
@@ -113,7 +113,7 @@ interface command_caller extends base_keyed_method_caller {
* "Reference0": "abc",
* "Reference1": "def"
* });
- * @group callers
+ * @group 调用器
*/
interface simple_command_caller extends simple_keyed_method_caller {
/**
@@ -131,7 +131,7 @@ interface simple_command_caller extends simple_keyed_method_caller
* let data = await jsstp.SEND({
* "Command": "GetNames"
* });
- * @group callers
+ * @group 调用器
*/
interface list_command_caller extends base_keyed_method_caller {
/**
@@ -147,7 +147,7 @@ interface list_command_caller extends base_keyed_method_caller {
* let data = await jsstp.SEND({
* "Command": "GetNames"
* });
- * @group callers
+ * @group 调用器
*/
interface simple_list_command_caller extends simple_keyed_method_caller {
/**
@@ -177,68 +177,114 @@ interface jsstp_with_ghost_info_t extends jsstp_t {
*/
declare class jsstp_t {
/**
- * @group Types
+ * jsstp对象
+ * @see {@link jsstp}
+ * @example
+ * let my_jsstp=new jsstp.type("my_coooool_jsstp",sstp_server_url);
+ * @group 类型
+ * @see {@link jsstp_t}
*/
type: typeof jsstp_t;
/**
- * @group Types
+ * 基础sstp报文类
+ * @example
+ * let info = new jsstp.sstp_info_t("SSTP/1.4 200 OK\r\nCharset: UTF-8\r\nSender: SSTPクライアント\r\nScript: \\h\\s0テストー。\\u\\s[10]テストやな。\r\nOption: notranslate\r\n\r\n");
+ * console.log(info.head);//SSTP/1.4 200 OK
+ * console.log(info.Option);//notranslate
+ * @group 类型
+ * @see {@link base_sstp_info_t}
*/
base_sstp_info_t: typeof base_sstp_info_t;
/**
- * @group Types
+ * sstp报文类
+ * @example
+ * let info = new jsstp.sstp_info_t("SSTP/1.4 200 OK\r\nCharset: UTF-8\r\nSender: SSTPクライアント\r\nScript: \\h\\s0テストー。\\u\\s[10]テストやな。\r\nOption: notranslate\r\n\r\n");
+ * console.log(info.head);//SSTP/1.4 200 OK
+ * console.log(info.Option);//notranslate
+ * @group 类型
+ * @see {@link sstp_info_t}
*/
sstp_info_t: typeof sstp_info_t;
/**
- * @group Types
+ * fmo报文类
+ * @example
+ * let fmo = jsstp.get_fmo_infos();
+ * let kikka_uuid = fmo.get_uuid_by("name", "橘花");
+ * if(kikka_uuid)
+ * console.log(fmo[kikka_uuid].ghostpath);
+ * @see {@link jsstp_t.get_fmo_infos}
+ * @see {@link https://ssp.shillest.net/ukadoc/manual/spec_fmo_mutex.html}
+ * @group 类型
+ * @see {@link fmo_info_t}
*/
fmo_info_t: typeof fmo_info_t;
/**
- * @group Types
+ * list报文对象
+ * @example
+ * let list = jsstp.GetNames();
+ * for(let name of list)
+ * console.log(name);
+ * @group 类型
+ * @see {@link list_info_t}
*/
list_info_t: typeof list_info_t;
/**
- * @group Types
+ * ghost事件查询器
+ * @example
+ * let ghost_events_queryer = jsstp.new_event_queryer();
+ * if(!ghost_events_queryer.available)
+ * console.log("当前ghost不支持事件查询");
+ * if(ghost_events_queryer.has_event("OnBoom"))
+ * jsstp.OnBoom();
+ * @see {@link jsstp_t.new_event_queryer}
+ * @group 类型
+ * @see {@link ghost_events_queryer_t}
*/
ghost_events_queryer_t: typeof ghost_events_queryer_t;
/**
- * @group SSTP Base Methods
+ * @group SSTP基础通讯类型
+ * @see https://ssp.shillest.net/ukadoc/manual/spec_sstp.html#method_send
*/
SEND: method_caller;
/**
- * @group SSTP Base Methods
+ * @group SSTP基础通讯类型
+ * @see https://ssp.shillest.net/ukadoc/manual/spec_sstp.html#method_notify
*/
NOTIFY: method_caller;
/**
- * @group SSTP Base Methods
+ * @group SSTP基础通讯类型
+ * @see https://ssp.shillest.net/ukadoc/manual/spec_sstp.html#method_communicate
*/
COMMUNICATE: method_caller;
/**
- * @group SSTP Base Methods
+ * @group SSTP基础通讯类型
+ * @see https://ssp.shillest.net/ukadoc/manual/spec_sstp.html#method_execute
*/
EXECUTE: method_caller;
/**
- * @group SSTP Base Methods
+ * @group SSTP基础通讯类型
+ * @see https://ssp.shillest.net/ukadoc/manual/spec_sstp.html#method_give
*/
GIVE: method_caller;
/**
* 匹配事件名称以产生简易调用器
- * @group Index reflections
+ * @group 访问反射
* @example
* let data=await jsstp.OnTest(123,"abc");
*/
[key: `On${string}`]: simple_event_caller;
/**
* 匹配事件名称以产生简易调用器
- * @group Index reflections
+ * @group 访问反射
* @example
* let data=await jsstp.GetNames();
*/
[key: `Get${string}`]: simple_list_command_caller;
/**
* 匹配事件名称以产生简易调用器
- * @group Index reflections
+ * @group 访问反射
* @example
* let data=await jsstp.SetCookie("abc","def");
*/
@@ -282,21 +328,21 @@ declare class jsstp_t {
/**
* 修改host
* @param {string} host
- * @group Properties
+ * @group 属性
*/
set host(host: string);
/*@__PURE__*/get host(): string;
/**
* 修改sendername
* @param {String} sender_name
- * @group Properties
+ * @group 属性
*/
set sendername(sender_name: String);
/*@__PURE__*/get sendername(): String;
/**
* 复制一个新的jsstp对象
- * @group Clone Methods
+ * @group 复制函数
*/
get clone(): jsstp_t;
@@ -304,7 +350,7 @@ declare class jsstp_t {
* 复制一个新的jsstp对象对于给定的fmo_info
* @param fmo_info 目标ghost的fmo_info
* @returns {jsstp_t} 新的指向目标ghost的jsstp对象
- * @group Clone Methods
+ * @group 复制函数
*/
by_fmo_info(fmo_info: single_fmo_info_t): jsstp_with_ghost_info_t;
@@ -323,7 +369,7 @@ declare class jsstp_t {
* 以文本发送报文并以文本接收返信
* @param {any} info 报文体(文本)
* @returns {Promise} 返回一个promise
- * @group Basic Send Methods
+ * @group 基础送信函数
*/
row_send(info: any): Promise;
/**
@@ -331,7 +377,7 @@ declare class jsstp_t {
* @param {String} sstphead 报文头
* @param {Object} info 报文体
* @returns {Promise} 返回一个promise
- * @group Basic Send Methods
+ * @group 基础送信函数
*/
costom_text_send(sstphead: String, info: Object): Promise;
/**
@@ -340,7 +386,7 @@ declare class jsstp_t {
* @param {Object} info 报文体
* @param {new (info: String)=> result_type} result_type 返回结果的类型,默认为sstp_info_t
* @returns {Promise} 返回一个promise
- * @group Basic Send Methods
+ * @group 基础送信函数
*/
costom_send(sstphead: String, info: Object, result_type: new (str: string) => T): Promise;
@@ -350,7 +396,7 @@ declare class jsstp_t {
* @param {new (info: String) => result_type} [result_type=sstp_info_t] 返回结果的类型,默认为sstp_info_t
* @param {Function} [args_processor=info => info] 参数处理器,默认直接返回输入参数
* @returns {method_caller} 调用器
- * @group Caller Methods
+ * @group 调用器生成函数
*/
/*@__PURE__*/get_caller_of_method(
method_name: String, result_type?: new (str: string) => T, args_processor?: (...args: Rest) => Res
@@ -362,7 +408,7 @@ declare class jsstp_t {
* @param {Function} method_caller 方法调用器
* @param {Function} args_processor 参数处理器
* @returns {Proxy} 调用器
- * @group Caller Methods
+ * @group 调用器生成函数
*/
/*@__PURE__*/get_caller_of_key(
key_name: String, value_name: String,
@@ -376,7 +422,7 @@ declare class jsstp_t {
* @param {String} value_name 键值
* @param {Function} method_caller 方法调用器
* @returns {Proxy} 调用器
- * @group Caller Methods
+ * @group 调用器生成函数
*/
/*@__PURE__*/get_simple_caller_of_key(
key_name: String, value_name: String,
@@ -387,7 +433,7 @@ declare class jsstp_t {
* @returns {Proxy}
* @example
* jsstp.event.OnTest("test");
- * @group Indexer Members
+ * @group 反射器成员
*/
/*@__PURE__*/get event(): {
[event_name: string]: simple_event_caller
@@ -397,7 +443,7 @@ declare class jsstp_t {
* @returns {Proxy}
* @example
* jsstp.command.GetFMO();
- * @group Indexer Members
+ * @group 反射器成员
*/
/*@__PURE__*/get command(): {
[command_name: string]: simple_command_caller
@@ -509,7 +555,7 @@ declare class jsstp_t {
* xxx.then(v => jsstp.if_available()).then(() => {
* //do something
* });
- * @group PromiseLike Methods
+ * @group 类Promise函数
*/
/*@__PURE__*/if_available(resolve: (value?: jsstp_t) => result_T): Promise;
/**
diff --git a/src/.decls/en/tsconfig.json b/src/.decls/en/tsconfig.json
index a01a342..4bcb259 100644
--- a/src/.decls/en/tsconfig.json
+++ b/src/.decls/en/tsconfig.json
@@ -13,7 +13,7 @@
"entryPoints": [
"jsstp.d.ts"
],
- "htmlLang": "en",
+ "lang": "en",
"out": "../../../.github/pages/doc/EN",
"readme": "../../../docs/README_EN.md",
}
diff --git a/src/.decls/en/types/jsstp_t.d.ts b/src/.decls/en/types/jsstp_t.d.ts
index 10ec93e..f34c26b 100644
--- a/src/.decls/en/types/jsstp_t.d.ts
+++ b/src/.decls/en/types/jsstp_t.d.ts
@@ -178,48 +178,94 @@ interface jsstp_with_ghost_info_t extends jsstp_t {
*/
declare class jsstp_t {
/**
+ * jsstp object
+ * @see {@link jsstp}
+ * @example
+ * let my_jsstp=new jsstp.type("my_coooool_jsstp",sstp_server_url);
* @group Types
+ * @see {@link jsstp_t}
*/
type: typeof jsstp_t;
/**
+ * Base sstp message class
+ * @example
+ * let info = new jsstp.sstp_info_t("SSTP/1.4 200 OK\r\nCharset: UTF-8\r\nSender: SSTP Client\r\nScript: \\h\\s0Testing!\\u\\s[10]It's a test.\r\nOption: notranslate\r\n\r\n");
+ * console.log(info.head);//SSTP/1.4 200 OK
+ * console.log(info.Option);//notranslate
* @group Types
+ * @see {@link base_sstp_info_t}
*/
base_sstp_info_t: typeof base_sstp_info_t;
/**
+ * sstp message class
+ * @example
+ * let info = new jsstp.sstp_info_t("SSTP/1.4 200 OK\r\nCharset: UTF-8\r\nSender: SSTP Client\r\nScript: \\h\\s0Testing!\\u\\s[10]It's a test.\r\nOption: notranslate\r\n\r\n");
+ * console.log(info.head);//SSTP/1.4 200 OK
+ * console.log(info.Option);//notranslate
* @group Types
+ * @see {@link sstp_info_t}
*/
sstp_info_t: typeof sstp_info_t;
/**
+ * fmo message class
+ * @example
+ * let fmo = jsstp.get_fmo_infos();
+ * let kikka_uuid = fmo.get_uuid_by("name", "橘花");
+ * if(kikka_uuid)
+ * console.log(fmo[kikka_uuid].ghostpath);
+ * @see {@link jsstp_t.get_fmo_infos}
+ * @see {@link https://ssp.shillest.net/ukadoc/manual/spec_fmo_mutex.html}
* @group Types
+ * @see {@link fmo_info_t}
*/
fmo_info_t: typeof fmo_info_t;
/**
+ * List message object
+ * @example
+ * let list = jsstp.GetNames();
+ * for(let name of list)
+ * console.log(name);
* @group Types
+ * @see {@link list_info_t}
*/
list_info_t: typeof list_info_t;
/**
+ * ghost event finder
+ * @example
+ * let ghost_events_queryer = jsstp.new_event_queryer();
+ * if(!ghost_events_queryer.available)
+ * console.log("Current ghost does not support event queries");
+ * if(ghost_events_queryer.has_event("OnBoom"))
+ * jsstp.OnBoom();
+ * @see {@link jsstp_t.new_event_queryer}
* @group Types
+ * @see {@link ghost_events_queryer_t}
*/
ghost_events_queryer_t: typeof ghost_events_queryer_t;
/**
* @group SSTP Base Methods
+ * @see https://ukagakadreamteam.github.io/ukadoc/manual/spec_sstp.html#method_send
*/
SEND: method_caller;
/**
* @group SSTP Base Methods
+ * @see https://ukagakadreamteam.github.io/ukadoc/manual/spec_sstp.html#method_notify
*/
NOTIFY: method_caller;
/**
* @group SSTP Base Methods
+ * @see https://ukagakadreamteam.github.io/ukadoc/manual/spec_sstp.html#method_communicate
*/
COMMUNICATE: method_caller;
/**
* @group SSTP Base Methods
+ * @see https://ukagakadreamteam.github.io/ukadoc/manual/spec_sstp.html#method_execute
*/
EXECUTE: method_caller;
/**
* @group SSTP Base Methods
+ * @see https://ukagakadreamteam.github.io/ukadoc/manual/spec_sstp.html#method_give
*/
GIVE: method_caller;
diff --git a/src/.decls/jp/tsconfig.json b/src/.decls/jp/tsconfig.json
index 12d9258..bfa410b 100644
--- a/src/.decls/jp/tsconfig.json
+++ b/src/.decls/jp/tsconfig.json
@@ -13,8 +13,13 @@
"entryPoints": [
"jsstp.d.ts"
],
- "htmlLang": "ja",
+ "lang": "jp",
"out": "../../../.github/pages/doc/JP",
"readme": "../../../docs/README_JP.md",
+ "locales": {
+ "jp": {
+ "tag_alias": "別名"
+ }
+ }
}
}
diff --git a/src/.decls/jp/types/jsstp_t.d.ts b/src/.decls/jp/types/jsstp_t.d.ts
index a0c11ef..6eeabce 100644
--- a/src/.decls/jp/types/jsstp_t.d.ts
+++ b/src/.decls/jp/types/jsstp_t.d.ts
@@ -8,7 +8,7 @@ import type { base_sstp_content_t, common_communicate_sstp_content_t, common_eve
/**
* sstp メソッド呼び出し元
- * @group callers
+ * @group 呼び出し元
*/
interface method_caller {
(...args: Rest): Promise;
@@ -19,7 +19,7 @@ interface method_caller {
/**
* 指定されたキー値へのメンバーアクセスによって拡張できる拡張呼び出し元
- * @group callers
+ * @group 呼び出し元
*/
interface base_keyed_method_caller extends method_caller {
/**
@@ -30,7 +30,7 @@ interface base_keyed_method_caller extends base_keyed_method_caller {
/**
@@ -54,7 +54,7 @@ interface simple_keyed_method_caller extends base_keyed_method_caller<
* "Reference0": 123,
* "Reference1": "abc"
* });
- * @group callers
+ * @group 呼び出し元
*/
interface event_caller extends base_keyed_method_caller {
/**
@@ -73,7 +73,7 @@ interface event_caller extends base_keyed_method_caller {
* "Reference0": 123,
* "Reference1": "abc"
* });
- * @group callers
+ * @group 呼び出し元
*/
interface simple_event_caller extends simple_keyed_method_caller {
/**
@@ -97,7 +97,7 @@ interface simple_event_caller extends simple_keyed_method_caller {
* "Reference0": "abc",
* "Reference1": "def"
* });
- * @group callers
+ * @group 呼び出し元
*/
interface command_caller extends base_keyed_method_caller {
/**
@@ -115,7 +115,7 @@ interface command_caller extends base_keyed_method_caller {
* "Reference0": "abc",
* "Reference1": "def"
* });
- * @group callers
+ * @group 呼び出し元
*/
interface simple_command_caller extends simple_keyed_method_caller {
/**
@@ -133,7 +133,7 @@ interface simple_command_caller extends simple_keyed_method_caller
* let data = await jsstp.SEND({
* "Command": "GetNames"
* });
- * @group callers
+ * @group 呼び出し元
*/
interface list_command_caller extends base_keyed_method_caller {
/**
@@ -149,7 +149,7 @@ interface list_command_caller extends base_keyed_method_caller {
* let data = await jsstp.SEND({
* "Command": "GetNames"
* });
- * @group callers
+ * @group 呼び出し元
*/
interface simple_list_command_caller extends simple_keyed_method_caller {
/**
@@ -179,68 +179,114 @@ interface jsstp_with_ghost_info_t extends jsstp_t {
*/
declare class jsstp_t {
/**
- * @group Types
+ * jsstpオブジェクト
+ * @see {@link jsstp}
+ * @example
+ * let my_jsstp=new jsstp.type("my_coooool_jsstp",sstp_server_url);
+ * @group クラス
+ * @see {@link jsstp_t}
*/
type: typeof jsstp_t;
/**
- * @group Types
+ * ベースsstpメッセージクラス
+ * @example
+ * let info = new jsstp.sstp_info_t("SSTP/1.4 200 OK\r\nCharset: UTF-8\r\nSender: SSTPクライアント\r\nScript: \\h\\s0テストー。\\u\\s[10]テストやな。\r\nOption: notranslate\r\n\r\n");
+ * console.log(info.head);//SSTP/1.4 200 OK
+ * console.log(info.Option);//notranslate
+ * @group クラス
+ * @see {@link base_sstp_info_t}
*/
base_sstp_info_t: typeof base_sstp_info_t;
/**
- * @group Types
+ * SSTPメッセージクラス
+ * @example
+ * let info = new jsstp.sstp_info_t("SSTP/1.4 200 OK\r\nCharset: UTF-8\r\nSender: SSTPクライアント\r\nScript: \\h\\s0テストー。\\u\\s[10]テストやな。\r\nOption: notranslate\r\n\r\n");
+ * console.log(info.head);//SSTP/1.4 200 OK
+ * console.log(info.Option);//notranslate
+ * @group クラス
+ * @see {@link sstp_info_t}
*/
sstp_info_t: typeof sstp_info_t;
/**
- * @group Types
+ * FMOメッセージクラス
+ * @example
+ * let fmo = jsstp.get_fmo_infos();
+ * let kikka_uuid = fmo.get_uuid_by("name", "橘花");
+ * if(kikka_uuid)
+ * console.log(fmo[kikka_uuid].ghostpath);
+ * @see {@link jsstp_t.get_fmo_infos}
+ * @see {@link https://ssp.shillest.net/ukadoc/manual/spec_fmo_mutex.html}
+ * @group クラス
+ * @see {@link fmo_info_t}
*/
fmo_info_t: typeof fmo_info_t;
/**
- * @group Types
+ * listメッセージオブジェクト
+ * @example
+ * let list = jsstp.GetNames();
+ * for(let name of list)
+ * console.log(name);
+ * @group クラス
+ * @see {@link list_info_t}
*/
list_info_t: typeof list_info_t;
/**
- * @group Types
+ * ゴースト・イベント・ファインダー
+ * @example
+ * let ghost_events_queryer = jsstp.new_event_queryer();
+ * if(!ghost_events_queryer.available)
+ * console.log("現在、ゴーストはイベントクエリをサポートしていません。");
+ * if(ghost_events_queryer.has_event("OnBoom"))
+ * jsstp.OnBoom();
+ * @see {@link jsstp_t.new_event_queryer}
+ * @group クラス
+ * @see {@link ghost_events_queryer_t}
*/
ghost_events_queryer_t: typeof ghost_events_queryer_t;
/**
- * @group SSTP Base Methods
+ * @group SSTP基本通信タイプ
+ * @see https://ssp.shillest.net/ukadoc/manual/spec_sstp.html#method_send
*/
SEND: method_caller;
/**
- * @group SSTP Base Methods
+ * @group SSTP基本通信タイプ
+ * @see https://ssp.shillest.net/ukadoc/manual/spec_sstp.html#method_notify
*/
NOTIFY: method_caller;
/**
- * @group SSTP Base Methods
+ * @group SSTP基本通信タイプ
+ * @see https://ssp.shillest.net/ukadoc/manual/spec_sstp.html#method_communicate
*/
COMMUNICATE: method_caller;
/**
- * @group SSTP Base Methods
+ * @group SSTP基本通信タイプ
+ * @see https://ssp.shillest.net/ukadoc/manual/spec_sstp.html#method_execute
*/
EXECUTE: method_caller;
/**
- * @group SSTP Base Methods
+ * @group SSTP基本通信タイプ
+ * @see https://ssp.shillest.net/ukadoc/manual/spec_sstp.html#method_give
*/
GIVE: method_caller;
/**
* イベント名をマッチさせて単純な呼び出し元を生成する
- * @group Index reflections
+ * @group インデックス反射
* @example
* let data=await jsstp.OnTest(123,"abc");
*/
[key: `On${string}`]: simple_event_caller;
/**
* イベント名をマッチさせて単純な呼び出し元を生成する
- * @group Index reflections
+ * @group インデックス反射
* @example
* let data=await jsstp.GetNames();
*/
[key: `Get${string}`]: simple_list_command_caller;
/**
* イベント名をマッチさせて単純な呼び出し元を生成する
- * @group Index reflections
+ * @group インデックス反射
* @example
* let data=await jsstp.SetCookie("abc","def");
*/
@@ -284,21 +330,21 @@ declare class jsstp_t {
/**
* ホストの変更
* @param {string} host
- * @group Properties
+ * @group プロパティ
*/
set host(host: string);
/*@__PURE__*/get host(): string;
/**
* 送信者名を変更する
* @param {String} sender_name
- * @group Properties
+ * @group プロパティ
*/
set sendername(sender_name: String);
/*@__PURE__*/get sendername(): String;
/**
* 新しいjsstpオブジェクトをコピーする
- * @group Clone Methods
+ * @group コピー関数
*/
get clone(): jsstp_t;
@@ -306,7 +352,7 @@ declare class jsstp_t {
* 与えられたfmo_infoに対して新しいjsstpオブジェクトをコピーする。
* @param fmo_info ターゲットゴーストのfm_info
* @returns {jsstp_t} ターゲットゴーストを指す新しいjsstpオブジェクト
- * @group Clone Methods
+ * @group コピー関数
*/
by_fmo_info(fmo_info: single_fmo_info_t): jsstp_with_ghost_info_t;
@@ -325,7 +371,7 @@ declare class jsstp_t {
* テキストでメッセージを送信し、テキストでそれを受信する
* @param {any} info メッセージ本文 (テキスト)
* @returns {Promise} プロミスを返します。
- * @group Basic Send Methods
+ * @group 基本的なメッセージング関数
*/
row_send(info: any): Promise;
/**
@@ -333,7 +379,7 @@ declare class jsstp_t {
* メッセージのヘッダー。
* @param {Object} info メッセージのボディ。
* @returns {Promise} プロミスを返します。
- * @group Basic Send Methods
+ * @group 基本的なメッセージング関数
*/
costom_text_send(sstphead: String, info: Object): Promise;
/**
@@ -342,7 +388,7 @@ declare class jsstp_t {
* @param {String} sstphead メッセージヘッダ
* @param {Object} info メッセージボディ
* @param {new (info: String)=> result_type} result_type 返される結果の型、デフォルトは sstp_info_t
- * @group Basic Send Methods
+ * @group 基本的なメッセージング関数
*/
costom_send(sstphead: String, info: Object, result_type: new (str: string) => T): Promise;
@@ -352,7 +398,7 @@ declare class jsstp_t {
* @param {new (info: String) => result_type} [result_type=sstp_info_t] 返される結果の型、デフォルトは sstp_info_t
* @param {Function} [args_processor=info => info] パラメータプロセッサ、デフォルトは入力パラメータを直接返す
* @returns {method_caller} 呼び出し元
- * @group Caller Methods
+ * @group 呼び出し元生成関数
*/
/*@__PURE__*/get_caller_of_method(
method_name: String, result_type?: new (str: string) => T, args_processor?: (...args: Rest) => Res
@@ -364,7 +410,7 @@ declare class jsstp_t {
* @param {Function} method_caller メソッド呼び出し元
* @param {Function} args_processor パラメータプロセッサ
* @returns {Proxy} 呼び出し元
- * @group Caller Methods
+ * @group 呼び出し元生成関数
*/
/*@__PURE__*/get_caller_of_key(
key_name: String, value_name: String,
@@ -378,7 +424,7 @@ declare class jsstp_t {
* @param {String} value_name value名
* @param {Function} method_caller メソッド呼び出し元
* @returns {Proxy} 呼び出し元
- * @group Caller Methods
+ * @group 呼び出し元生成関数
*/
/*@__PURE__*/get_simple_caller_of_key(
key_name: String, value_name: String,
@@ -389,7 +435,7 @@ declare class jsstp_t {
* @returns {Proxy}
* @example
* jsstp.event.OnTest("test");
- * @group Indexer Members
+ * @group リフレクターメンバー
*/
/*@__PURE__*/get event(): {
[event_name: string]: simple_event_caller
@@ -399,7 +445,7 @@ declare class jsstp_t {
* @returns {Proxy}
* @example
* jsstp.command.GetFMO();
- * @group Indexer Members
+ * @group リフレクターメンバー
*/
/*@__PURE__*/get command(): {
[command_name: string]: simple_command_caller
@@ -511,7 +557,7 @@ declare class jsstp_t {
* xxx.then(v => jsstp.if_available()).then(() => {
* //do something
* });
- * @group PromiseLike Methods
+ * @group Promiseのような関数
*/
/*@__PURE__*/if_available(resolve: (value?: jsstp_t) => result_T): Promise;
/**