Skip to content

Commit 2ff9d13

Browse files
committed
chore: update docs
1 parent d80cab9 commit 2ff9d13

File tree

1 file changed

+39
-33
lines changed

1 file changed

+39
-33
lines changed

README.md

Lines changed: 39 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -12,55 +12,61 @@
1212

1313
## Features
1414

15+
- 🌈 可能是东半球最全的第三方 SDK
1516
- ⭐️ 同时支持 Node.js / 浏览器 / Deno
1617
- 🦾 自带 TypeScript 类型声明
1718

1819
<details>
1920
<summary>API 列表</summary>
2021

2122
- [用户](http://jike-sdk.surge.sh/modules/api_users.html)
22-
- [x] [获取用户信息](http://jike-sdk.surge.sh/modules/api_users.html#profile)
23-
- [x] [刷新 Access Token](http://jike-sdk.surge.sh/modules/api_users.html#refreshToken)
24-
- [x] [发送登录验证码](http://jike-sdk.surge.sh/modules/api_users.html#getSmsCode)
25-
- [x] [短信登录](http://jike-sdk.surge.sh/modules/api_users.html#loginWithSmsCode)
26-
- [x] [手机号与密码登录](手机号与密码登录)
27-
- [x] [弹一弹头像](http://jike-sdk.surge.sh/modules/api_users.html#avatarGreet)
23+
- [x] [获取用户信息](http://jike-sdk.surge.sh/functions/api_users.profile.html)
24+
- [x] [刷新 Access Token](http://jike-sdk.surge.sh/functions/api_users.refreshToken.html)
25+
- [x] [发送登录验证码](http://jike-sdk.surge.sh/functions/api_users.getSmsCode.html)
26+
- [x] [短信登录](http://jike-sdk.surge.sh/functions/api_users.loginWithSmsCode.html)
27+
- [x] [手机号与密码登录](http://jike-sdk.surge.sh/functions/api_users.loginWithPhoneAndPassword.html)
28+
- [x] [弹一弹头像](http://jike-sdk.surge.sh/functions/api_users.avatarGreet.html)
2829
- [ ] ~~保存设备 Token~~
2930
- [用户关系](http://jike-sdk.surge.sh/modules/api_user_relation.html)
30-
- [x] [获取关注列表](http://jike-sdk.surge.sh/modules/api_user_relation.html#getFollowingList)
31-
- [x] [获取被关注列表](http://jike-sdk.surge.sh/modules/api_user_relation.html#getFollowerList)
32-
- [x] [关注](http://jike-sdk.surge.sh/modules/api_user_relation.html#follow)
33-
- [x] [取消关注](http://jike-sdk.surge.sh/modules/api_user_relation.html#unfollow)
31+
- [x] [获取关注列表](http://jike-sdk.surge.sh/functions/api_user_relation.getFollowingList.html)
32+
- [x] [获取被关注列表](http://jike-sdk.surge.sh/functions/api_user_relation.getFollowerList.html)
33+
- [x] [关注](http://jike-sdk.surge.sh/functions/api_user_relation.follow.html)
34+
- [x] [取消关注](http://jike-sdk.surge.sh/functions/api_user_relation.unfollow.html)
3435
- [x] [是否关注用户](http://jike-sdk.surge.sh/classes/index.JikeUser.html#isFollowing)
35-
- [x] [不看 TA 的内容](http://jike-sdk.surge.sh/modules/api_user_relation.html#mute)
36-
- [x] [重新看 TA 的内容](http://jike-sdk.surge.sh/modules/api_user_relation.html#unmute)
36+
- [x] [不看 TA 的内容](http://jike-sdk.surge.sh/functions/api_user_relation.mute.html)
37+
- [x] [重新看 TA 的内容](http://jike-sdk.surge.sh/functions/api_user_relation.unmute.html)
3738
- [动态帖子](http://jike-sdk.surge.sh/modules/api_posts.html)
38-
- [x] [发送动态](http://jike-sdk.surge.sh/modules/api_posts.html#create)
39-
- [x] [获取动态详情](http://jike-sdk.surge.sh/modules/api_posts.html#get)
40-
- [x] [分享动态](http://jike-sdk.surge.sh/modules/api_posts.html#share)
41-
- [x] [点赞](http://jike-sdk.surge.sh/modules/api_posts.html#like)
42-
- [x] [取消点赞](http://jike-sdk.surge.sh/modules/api_posts.html#unlike)
43-
- [x] [获取点赞用户列表](http://jike-sdk.surge.sh/modules/api_posts.html#listLikedUsers)
39+
- [x] [发送动态](http://jike-sdk.surge.sh/functions/api_posts.create.html)
40+
- [x] [获取动态详情](http://jike-sdk.surge.sh/functions/api_posts.get.html)
41+
- [x] [删除动态](http://jike-sdk.surge.sh/functions/api_posts.remove.html)
42+
- [x] [分享动态](http://jike-sdk.surge.sh/functions/api_posts.share.html)
43+
- [x] [点赞](http://jike-sdk.surge.sh/functions/api_posts.like.html)
44+
- [x] [取消点赞](http://jike-sdk.surge.sh/functions/api_posts.unlike.html)
45+
- [x] [获取点赞用户列表](http://jike-sdk.surge.sh/functions/api_posts.listLikedUsers.html)
4446
- [动态广场](http://jike-sdk.surge.sh/modules/api_recommend_feed.html)
45-
- [x] [获取动态推荐](http://jike-sdk.surge.sh/modules/api_recommend_feed.html#list)
46-
- 评论
47-
- [x] [获取评论](http://jike-sdk.surge.sh/modules/api_comments.html#listPrimary)
48-
- [x] [发送评论](http://jike-sdk.surge.sh/modules/api_comments.html#add)
49-
- [x] [点赞](http://jike-sdk.surge.sh/modules/api_comments.html#like)
50-
- [x] [取消点赞](http://jike-sdk.surge.sh/modules/api_comments.html#unlike)
47+
- [x] [获取动态推荐](http://jike-sdk.surge.sh/functions/api_recommend_feed.list.html)
48+
- [评论](http://jike-sdk.surge.sh/modules/api_comments.html)
49+
- [x] [获取评论](http://jike-sdk.surge.sh/functions/api_comments.listPrimary.html)
50+
- [x] [发送评论](http://jike-sdk.surge.sh/functions/api_comments.add.html)
51+
- [x] [点赞](http://jike-sdk.surge.sh/functions/api_comments.like.html)
52+
- [x] [取消点赞](http://jike-sdk.surge.sh/functions/api_comments.unlike.html)
5153
- [动态](http://jike-sdk.surge.sh/modules/api_personal_update.html)
52-
- [x] [获取用户动态](http://jike-sdk.surge.sh/modules/api_personal_update.html#single)
53-
- [x] [获取关注动态](http://jike-sdk.surge.sh/modules/api_personal_update.html#followingUpdates)
54-
- [x] [置顶动态](http://jike-sdk.surge.sh/modules/api_personal_update.html#pin)
55-
- [x] [取消置顶动态](http://jike-sdk.surge.sh/modules/api_personal_update.html#unpin)
54+
- [x] [获取用户动态](http://jike-sdk.surge.sh/functions/api_personal_update.single.html)
55+
- [x] [获取关注动态](http://jike-sdk.surge.sh/functions/api_personal_update.followingUpdates.html)
56+
- [x] [置顶动态](http://jike-sdk.surge.sh/functions/api_personal_update.pin.html)
57+
- [x] [取消置顶动态](http://jike-sdk.surge.sh/functions/api_personal_update.unpin.html)
5658
- [通知](http://jike-sdk.surge.sh/modules/api_notifications.html)
57-
- [x] [获取通知列表](http://jike-sdk.surge.sh/modules/api_notifications.html#list)
59+
- [x] [获取通知列表](http://jike-sdk.surge.sh/functions/api_notifications.list.html)
5860
- [上传](http://jike-sdk.surge.sh/modules/api_upload.html)
59-
- [x] [获取上传 token](http://jike-sdk.surge.sh/modules/api_upload.html#token)
60-
- [x] [上传图片](http://jike-sdk.surge.sh/modules/api_upload.html#upload)
61+
- [x] [获取上传 token](http://jike-sdk.surge.sh/functions/api_upload.token.html)
62+
- [x] [上传图片](http://jike-sdk.surge.sh/functions/api_upload.upload.html)
6163
- [日记](http://jike-sdk.surge.sh/modules/api_stories.html)
62-
- [x] [获取关注用户日记列表](http://jike-sdk.surge.sh/modules/api_stories.html#followingFeed)
63-
- [x] [获取用户的日记详情](http://jike-sdk.surge.sh/modules/api_stories.html#listUserStories)
64+
- [x] [获取关注用户日记列表](http://jike-sdk.surge.sh/functions/api_stories.followingFeed.html)
65+
- [x] [获取用户的日记详情](http://jike-sdk.surge.sh/functions/api_stories.listUserStories.html)
66+
- [圈子](http://jike-sdk.surge.sh/modules/api_topics.html)
67+
- [x] [获取圈子热门动态](http://jike-sdk.surge.sh/functions/api_topics.getTabsSelectedFeed.html)
68+
- [x] [获取圈子动态](http://jike-sdk.surge.sh/functions/api_topics.getTabsSquareFeed.html)
69+
- [x] [搜索圈子](http://jike-sdk.surge.sh/functions/api_topics.search.html)
6470

6571
</details>
6672

0 commit comments

Comments
 (0)