From cf70ac5cbfa7afe5d2d2a2572144eb62f217e19d Mon Sep 17 00:00:00 2001 From: Taromati2 Date: Sun, 16 Jun 2024 05:37:57 +0000 Subject: [PATCH] file update~ --- dist/cn/jsstp.d.ts | 112 ++++++++++++++++++++++++++++++++------------- dist/en/jsstp.d.ts | 46 +++++++++++++++++++ dist/jp/jsstp.d.ts | 112 ++++++++++++++++++++++++++++++++------------- 3 files changed, 204 insertions(+), 66 deletions(-) diff --git a/dist/cn/jsstp.d.ts b/dist/cn/jsstp.d.ts index 8649429..a2ec6b2 100644 --- a/dist/cn/jsstp.d.ts +++ b/dist/cn/jsstp.d.ts @@ -723,7 +723,7 @@ declare class list_info_t extends base_sstp_info_t { /** * sstp方法调用器 - * @group callers + * @group 调用器 */ interface method_caller { (...args: Rest): Promise; @@ -734,7 +734,7 @@ interface method_caller { /** * 可以通过成员访问扩充指定key值的拓展调用器 - * @group callers + * @group 调用器 */ interface base_keyed_method_caller extends method_caller { /** @@ -744,7 +744,7 @@ interface base_keyed_method_caller extends base_keyed_method_caller { /** @@ -763,7 +763,7 @@ interface simple_keyed_method_caller extends base_keyed_method_caller< * "Reference0": 123, * "Reference1": "abc" * }); - * @group callers + * @group 调用器 */ interface simple_event_caller extends simple_keyed_method_caller { /** @@ -781,7 +781,7 @@ interface simple_event_caller extends simple_keyed_method_caller { * "Reference0": "abc", * "Reference1": "def" * }); - * @group callers + * @group 调用器 */ interface simple_command_caller extends simple_keyed_method_caller { /** @@ -797,7 +797,7 @@ interface simple_command_caller extends simple_keyed_method_caller * let data = await jsstp.SEND({ * "Command": "GetNames" * }); - * @group callers + * @group 调用器 */ interface simple_list_command_caller extends simple_keyed_method_caller { /** @@ -826,68 +826,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"); */ @@ -931,21 +977,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; @@ -953,7 +999,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; @@ -972,7 +1018,7 @@ declare class jsstp_t { * 以文本发送报文并以文本接收返信 * @param {any} info 报文体（文本） * @returns {Promise} 返回一个promise - * @group Basic Send Methods + * @group 基础送信函数 */ row_send(info: any): Promise; /** @@ -980,7 +1026,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; /** @@ -989,7 +1035,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; @@ -999,7 +1045,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 @@ -1011,7 +1057,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, @@ -1025,7 +1071,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, @@ -1036,7 +1082,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 @@ -1046,7 +1092,7 @@ declare class jsstp_t { * @returns {Proxy} * @example * jsstp.command.GetFMO(); - * @group Indexer Members + * @group 反射器成员 */ /*@__PURE__*/get command(): { [command_name: string]: simple_command_caller @@ -1158,7 +1204,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/dist/en/jsstp.d.ts b/dist/en/jsstp.d.ts index 47a12c3..2f567fb 100644 --- a/dist/en/jsstp.d.ts +++ b/dist/en/jsstp.d.ts @@ -821,48 +821,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/dist/jp/jsstp.d.ts b/dist/jp/jsstp.d.ts index eaf4253..7b3ef38 100644 --- a/dist/jp/jsstp.d.ts +++ b/dist/jp/jsstp.d.ts @@ -718,7 +718,7 @@ declare class list_info_t extends base_sstp_info_t { /** * sstp メソッド呼び出し元 - * @group callers + * @group 呼び出し元 */ interface method_caller { (...args: Rest): Promise; @@ -729,7 +729,7 @@ interface method_caller { /** * 指定されたキー値へのメンバーアクセスによって拡張できる拡張呼び出し元 - * @group callers + * @group 呼び出し元 */ interface base_keyed_method_caller extends method_caller { /** @@ -739,7 +739,7 @@ interface base_keyed_method_caller extends base_keyed_method_caller { /** @@ -758,7 +758,7 @@ interface simple_keyed_method_caller extends base_keyed_method_caller< * "Reference0": 123, * "Reference1": "abc" * }); - * @group callers + * @group 呼び出し元 */ interface simple_event_caller extends simple_keyed_method_caller { /** @@ -776,7 +776,7 @@ interface simple_event_caller extends simple_keyed_method_caller { * "Reference0": "abc", * "Reference1": "def" * }); - * @group callers + * @group 呼び出し元 */ interface simple_command_caller extends simple_keyed_method_caller { /** @@ -792,7 +792,7 @@ interface simple_command_caller extends simple_keyed_method_caller * let data = await jsstp.SEND({ * "Command": "GetNames" * }); - * @group callers + * @group 呼び出し元 */ interface simple_list_command_caller extends simple_keyed_method_caller { /** @@ -821,68 +821,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"); */ @@ -926,21 +972,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; @@ -948,7 +994,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; @@ -967,7 +1013,7 @@ declare class jsstp_t { * テキストでメッセージを送信し、テキストでそれを受信する * @param {any} info メッセージ本文 (テキスト) * @returns {Promise} プロミスを返します。 - * @group Basic Send Methods + * @group 基本的なメッセージング関数 */ row_send(info: any): Promise; /** @@ -975,7 +1021,7 @@ declare class jsstp_t { * メッセージのヘッダー。 * @param {Object} info メッセージのボディ。 * @returns {Promise} プロミスを返します。 - * @group Basic Send Methods + * @group 基本的なメッセージング関数 */ costom_text_send(sstphead: String, info: Object): Promise; /** @@ -984,7 +1030,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; @@ -994,7 +1040,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 @@ -1006,7 +1052,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, @@ -1020,7 +1066,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, @@ -1031,7 +1077,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 @@ -1041,7 +1087,7 @@ declare class jsstp_t { * @returns {Proxy} * @example * jsstp.command.GetFMO(); - * @group Indexer Members + * @group リフレクターメンバー */ /*@__PURE__*/get command(): { [command_name: string]: simple_command_caller @@ -1153,7 +1199,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; /**