Blocklet SDK (Browser)
zhanghan
2024-08-05 00:54
· edited
Blocklet JS SDK 是 Blocklet 平台提供用于浏览器中的部分辅助工具库。
它主要包含以下功能:
- 提供能自动更新 token 的 fetch 和 axios 创建函数
- 提供用户个人信息相关的接口请求
初始化实例#
import { BlockletSDK } from '@blocklet/js-sdk';
const sdk = new BlockletSDK();
用户信息实例#
user.getUserPublicInfo
获取用户的公开信息
type UserPublicInfo = {
avatar: string;
did: string;
fullName: string;
};
const publicInfo: UserPublicInfo = await sdk.user.getUserPublicInfo(userDid: string);
user.getProfileUrl
获取用户个人中心地址
const profileUrl = await sdk.user.getProfileUrl({did: string; locale: string});
user.logout
退出登录
await sdk.user.logout();
创建 axios 实例#
createAxios
该实例会管理更新 sessionToken 和 refreshToken
import { createAxios } from '@blocklet/js-sdk';
import type { AxiosRequestConfig, AxiosInstance } from 'axios';
type RequestParams = {
lazy?: boolean; // 是否需要将请求延迟响应
lazyTime?: number; // 延迟响应的时间,默认 300 ms
};
const api = createAxios(config?: AxiosRequestConfig, requestParams?:RequestParams)
createFetch
该实例会管理更新 sessionToken 和 refreshToken
import { createFetch } from '@blocklet/js-sdk';
type RequestParams = {
lazy?: boolean; // 是否需要将请求延迟响应
lazyTime?: number; // 延迟响应的时间,默认 300 ms
};
const api = createFetch(options?: RequestInit, requestParams?:RequestParams)
Sticker