Merge pull request #38 from takayama-lily/dev

-

Author: takayama-lily

client.js

@@ -11,6 +11,11 @@
   + [client.captchaLogin(captcha)](#client.captchaLogin(captcha))
   + [client.terminate()](#client.terminate())
   + [APIs](#APIs)
+    + [获取列表](#获取好友群群员列表和info)
+    + [发消息和撤回](#发私聊消息群消息)
+    + [群操作](#群操作踢人禁言退群设置等)
+    + [加好友](#加好友删好友邀请好友入群点赞)
+    + [设置状态和资料](#设置状态和资料)
 + [oicq.setGlobalConfig(config)](#oicq.setGlobalConfig(config))
 
 ----
@@ -187,14 +192,18 @@ client.on("system.login.captcha", (data)=>{
     + *`user_id`*
     + *`message_id`*
 
+  + `notice.friend.nickname` 好友更新昵称
+    + *`user_id`*
+    + *`nickname`*
+
 + **notice.group**
 
   + `notice.group.increase` 群员增加
     + *`group_id`*
     + *`user_id`*
     + *`nickname`*
 
-  + `notice.group.decrease` 群员减少(bot在其他客户端自己退群，事件不会触发)
+  + `notice.group.decrease` 群员减少
     + *`group_id`*
     + *`operator_id`* 操作者，自己退群的时候和user_id相同
     + *`user_id`*
@@ -206,7 +215,7 @@ client.on("system.login.captcha", (data)=>{
     + *`user_id`*
     + *`message_id`*
 
-  + `notice.group.admin` 管理变更事件(bot是群主，在其他客户端设置管理，事件不会触发)
+  + `notice.group.admin` 管理变更事件
     + *`group_id`*
     + *`user_id`*
     + *`set`* boolean型
@@ -311,9 +320,9 @@ client.on("system.login.captcha", (data)=>{
 
 ### 获取好友、群、群员列表和info
 
-+ async `client.getFriendList([no_cache])`
-+ async `client.getGroupList([no_cache])`
-+ async `client.getGroupMemberList(group_id[, no_cache])`
++ `client.getFriendList()`
++ `client.getGroupList()`
++ async `client.getGroupMemberList(group_id)`
   + 获取列表返回的是ES6的Map类型，不是数组
 + async `client.getGroupInfo(group_id[, no_cache])`
 + async `client.getGroupMemberInfo(group_id, user_id[, no_cache])`
@@ -355,7 +364,7 @@ message可以使用 `Array` 格式或 `String` 格式，支持CQ码
 
 ----
 
-## 加好友、删好友、邀请好友入群、点赞
+### 加好友、删好友、邀请好友入群、点赞
 
 + async `client.addFriend(group_id, user_id[, comment])`
 + async `client.deleteFriend(user_id[, block])` block(屏蔽)默认是true
@@ -364,7 +373,7 @@ message可以使用 `Array` 格式或 `String` 格式，支持CQ码
 
 ----
 
-## 设置状态和资料
+### 设置状态和资料
 
 + async `client.setOnlineStatus(status)` 仅支持手机协议
   + `status` 允许的值：11我在线上 31离开 41隐身 50忙碌 60Q我吧 70请勿打扰
@@ -376,7 +385,7 @@ message可以使用 `Array` 格式或 `String` 格式，支持CQ码
 
 ----
 
-## 其他
+### 其他
 
 + `client.canSendImage()`
 + `client.canSendRecord()`

docs/api.md

@@ -84,7 +84,7 @@ function toInt(uin) {
  * @returns {Boolean}
  */
 function checkUin(uin) {
-    return uin > 10000 && uin < 0xffffffff;
+    return uin >= 10000 && uin <= 0xffffffff;
 }
 
 function code2uin(groupCode) {
@@ -125,7 +125,7 @@ function uin2code(groupUin) {
 }
 
 function log(any) {
-    console.log(util.inspect(any, {depth: 20, showHidden: true, maxArrayLength: 1000, maxStringLength: 1000}));
+    console.log(util.inspect(any, {depth: 20, showHidden: false, maxArrayLength: 1000, maxStringLength: 5000}));
 }
 
 module.exports = {