Skip to content

Latest commit

 

History

History
265 lines (195 loc) · 9.89 KB

README.md

File metadata and controls

265 lines (195 loc) · 9.89 KB
Raw

日本語 English 中文

jsstp

jsDelivr hits npm下载量 npm bundle大小

用js在网页或node.js等环境中与伪春菜通信以实现信息交换。 详情参考伪春菜与SSTP。

用法

1. 引入js

npm

如果你使用npm，你可以使用npm安装jsstp

npm i jsstp

之后在js中使用import引入jsstp

import jsstp from "jsstp";
//或者
var {jsstp}=await import("jsstp");

在CommonJS中，你也可以使用require引入jsstp

var {jsstp}=require('jsstp');

cdn

或者你是怀旧党，你可以通过cdn访问jsstp的源码

<script src="https://cdn.jsdelivr.net/gh/ukatech/[email protected]/dist/jsstp.min.js"></script>

或者在js中动态载入jsstp

var {jsstp}=await import("https://cdn.jsdelivr.net/gh/ukatech/[email protected]/dist/jsstp.mjs");
类型定义

即使使用cdn并手把手编写js代码，你也可以在ide中使用jsstp的类型定义文件以获得代码提示

首先确保你的ide可以访问jsstp，你或许可以全局安装它来在不干扰工作区文件的情况下使用它

npm i -g jsstp

随后，在使用jsstp的文件头部添加类型导入，根据types约定，这个声明必须在任何正式代码之前

/// <reference types="jsstp" />

最后在jsstp的声明前用JSDoc注释声明其类型

/** @type {typeof import("jsstp").jsstp} */
var jsstp;
类型定义：i18n

jsstp的类型定义提供了中日英三语的支持，正常情况下你可以这样指定加载的语言

/// <reference types="jsstp/cn" />
// or
/// <reference types="jsstp/jp" />
// or
/// <reference types="jsstp/en" />

不过如果你的ide在这样使用时出了错（或者你懒得每次都指定语言），你可以考虑手动修改package.json中的types字段来指定默认的语言

{
	"types": "dist/cn/jsstp.d.ts"
}

2. 使用

jsstp现在有专门的文档页面了！
你可以访问https://ukatech.github.io/jsstp-lib/doc来获取更专业的信息
在观看文档的过程中，你可以在jsstp playground中尝试jsstp的各种功能

你可能需要先在jsstp相关操作前检查ghost是否可用

if (!await jsstp.available())
	console.log("ghost不可用,请检查ghost是否启动");

jsstp2.0前曾经支持将回调函数作为参数传入，现在已经不再支持
如果你需要的话，可以使用Promise或者async/await来获取返回值
你可以使用jsstp.SEND来发送报文

jsstp.SEND(
	{//事件信息
		"Event": "OnTest",
		"Script": "\\0Hello, World!\\e"
	}
).then((data) => {
	console.log("head: " + data.head);
	console.log(JSON.stringify(data));
	console.log(data["Script"]);
});

jsstp支持所有的sstp基础操作，jsstp.[SEND|NOTIFY|COMMUNICATE|EXECUTE|GIVE]都可以被调用。
如果你喜欢怀旧，只想获得报文本身，你可以使用jsstp.[SEND|NOTIFY|COMMUNICATE|EXECUTE|GIVE].get_raw

如果你只是想触发事件，而不需要自定义发送较为复杂的报文，可以这样写

let data = await jsstp.OnTest("from jsstp.js!", 123123);

这等价于：

let data = await jsstp.SEND({
	"Event": "OnTest",
	"Reference0": "from jsstp.js!",
	"Reference1": 123123
});

对于所有事件你都可以这样写，不过如果事件不以On开头，你需要在事件名前加上On_来访问jsstp，这样它才能识别到你想要触发事件
你也可以使用jsstp.event.事件名(参数)来触发事件，这样你就不需要在事件名前加上On_了

在获取到返回内容后，其类型是jsstp.sstp_info_t，使用方法各种各样

  • 以下是自info_object继承的方法
data.keys; //获取所有键
data.values; //获取所有值
data.entries; //获取所有键值对
data.length; //获取键值对数量
data.forEach((value, key) => console.log(key + "=" + value)); //遍历所有键值对：如果遍历函数有返回值，该值会被更新到此键值对中
//省略key参数可以只遍历值
data.map((value, key) => value + "1"); //遍历所有键值对并返回一个由遍历函数返回值组成的数组
//省略key参数可以只遍历值
  • 以下是自jsstp.base_sstp_info_t继承的方法
data.status_code; //获取状态码
data.head; //获取报文头
data.Script; //获取报文中的Script键的值（其他键也可以这样获取）
data.status_code_text; //获取报文头中的状态码文本
  • 以下是jsstp.sstp_info_t自有的方法
data.get_passthrough("Result");
//获取报文中`X-SSTP-PassThru`的某个键的值，和`data["X-SSTP-PassThru-Result"]`等价
//你也可以直接使用`data.Result`或者`data["Result"]`来获取`X-SSTP-PassThru-Result`的值：这可能简洁一些
data.passthroughs; //获取所有`X-SSTP-PassThru`键值对
data.raw; //去除代理，访问原始对象

sstp_info_t自构造起便被一层代理包裹着，考虑到大多数情况开发者不需要访问非X-SSTP-PassThru键值对，此代理会在你访问某个键而该键存在X-SSTP-PassThru版本时优先返回X-SSTP-PassThru-{key}键的值。
换句话说，假若返回的报文有Script键和X-SSTP-PassThru-Script键，那么data.Script或data["Script"]会返回X-SSTP-PassThru-Script的值，而data.raw.Script和data.raw["Script"]会返回Script的值。
大多数情况下这个代理会减轻你的代码量，而在你需要访问非X-SSTP-PassThru键值对时，请一定记得使用data.raw来访问原始对象。

如果你想获取ghost是否支持某个事件，可以这样写

let result = await jsstp.has_event("OnTest");//这和jsstp.event.Has_Event(event_name, security_level).then(({ Result }) => Result == "1")几乎一样！
console.log(result);

如果你想大批量的查询事件（像ukadoc那样！），你可以使用jsstp.new_event_queryer()来获取一个queryer

let queryer = await jsstp.new_event_queryer();

queryer的类型是jsstp.ghost_events_queryer_t，使用方法各种各样

queryer.check_event("OnTest").then(result => console.log(result));

queryer和jsstp一样，检查事件时有可选的参数指定事件的安全等级，默认的安全等级随着jsstp的运行环境而变化：
如果jsstp运行在node.js中，安全等级为local，如果jsstp运行在浏览器中，安全等级为external（因为浏览器中的jsstp只能触发外部事件！）
如果你想要固定查询local事件，你需要指定安全等级为local，像这样：

queryer.check_event("OnBoot", "local");
jsstp.has_event("OnBoot", "local");//使用jsstp的话这样

queryer还支持一些快速检测
queryer与构造它的jsstp实例是绑定的，如果你想要让queryer指向特定的ghost，通过设置jsstp.default_info来修改默认的附加报文并使用reset清空缓存

//使用fmo中得到的hwnd，这可以避免重名导致的尴尬情况
jsstp.default_info.ReceiverGhostHWnd = fmo[uuid].hwnd;//fmo的获取方法见下文，这里只是举个例子
await queryer.reset();

如果你确定你的ghost名称足够独特，你也可以直接使用ghost名称，这两个方法只用其中一个就可以了

jsstp.default_info.ReceiverGhostName = "橘花";
await queryer.reset();

queryer还支持一些快速检测用于检查queryer的可用性

if (!queryer.available)
	console.info("无法获取支持的事件列表");//queryer不可用，你需要提醒用户更新ghost或者向其作者反馈：jsstp和ghost terminal一样使用`Has_Event`事件来检查事件的可用情况。
if (!queryer.fast_query_available)
	console.info("无法快速获取支持的事件列表");//这不会影响使用，只是会导致查询未缓存的事件时会发出一次查询请求：如果ghost支持`Get_Supported_Events`事件的话queryer会使用它来获取事件列表（这样会快不少！）
else
	console.info("好哦");

如果你想获取fmo信息，可以这样写

let fmo = await jsstp.get_fmo_infos();
if (fmo.available)
	console.log(fmo);

fmo的类型是jsstp.fmo_info_t，使用方法各种各样
fmo_info_t是特化的base_sstp_info_t，所以你可以对其使用base_sstp_info_t的所有方法（也就是说，sstp_info_t的所有方法除了get_passthrough）
它还有一些特殊的方法

fmo.uuids; //获取所有uuid，和`fmo.keys`等价
fmo.get_uuid_by("fullname", "Taromati2"); //获取指定属性值与指定值相等的uuid
fmo.get_list_of("fullname"); //获取指定属性的所有值
fmo.available; //获取fmo是否有内容

fmo的每个键值对都是String:info_object，键是uuid，值是该uuid对应的fmo信息
你仍然可以使用info_object的成员方法来操作fmo的中的fmo信息（参见上文中对于sstp_info_t的介绍）
如果你还是不太理解，可以在控制台查看fmo的结构或者查看jsstp的源码