@@ -60,9 +60,10 @@ let Abra = new Abracadabra(); //不附带参数,
6060 * @param {string} mode 指定模式,可以是 ENCRYPT DECRYPT 中的一种;
6161 * @param {string} key 指定密钥,默认是 ABRACADABRA;
6262 * @param {WenyanConfig} WenyanConfigObj 文言文的生成配置;
63+ * @param {any} callback 回调函数,获取执行过程中特定位置的结果
6364 * @return {number} 成功则返回 0(失败不会返回,会抛出异常)
6465 */
65- Abra .WenyanInput (input, mode, key, {... });
66+ Abra .WenyanInput (input, mode, key, {... }, callback );
6667```
6768
6869第一个参数 ` input ` 接受两种类型的输入,分别是 ` String ` 和 ` Uint8Array ` ,这是此前在实例化的时候指定的输入类型。
@@ -75,6 +76,8 @@ Abra.WenyanInput(input, mode, key, {...});
7576
7677如果指定了错误的密码,那么在解码/解密数据校验过程中会抛出错误。
7778
79+ 第五个参数 ` callback ` 接受一个回调函数,缺省时为 ` null ` 。程序会在执行中关键位置多次调用此函数,以便调试,无调试需求可忽略此项。
80+
7881第四个参数接受一个` WenyanConfig ` 配置对象的输入,仅在加密的时候需要:
7982
8083``` javascript
@@ -87,6 +90,8 @@ export interface WenyanConfig {
8790 PianwenMode ?: boolean ;
8891 /** 指定是否强制生成逻辑密文,默认 false; */
8992 LogicMode ?: boolean ;
93+ /** 指定输出文本是否为繁体中文,默认 false; */
94+ Traditional ?: boolean ;
9095}
9196```
9297
@@ -98,6 +103,8 @@ export interface WenyanConfig {
98103
99104` LogicMode ` 是布尔值,默认为 ` false ` 。如果传入 ` true ` ,则加密结果会优先使用逻辑句式,呈现强论述类逻辑风格。解密时可以忽略这个参数。
100105
106+ ` Traditional ` 是布尔值,默认为 ` false ` 。如果传入 ` true ` ,则加密结果会自动转换为繁体中文(香港)。解密时可以忽略这个参数。
107+
101108` PianwenMode ` 和 ` LogicMode ` 不能同时指定为 ` true ` ,否则会抛出错误。
102109
103110``` javascript
0 commit comments