MS JavaScript SDK

美术 JavaScript SDK for QuickApp，提供快应用开发所需的核心功能模块。

安装

npm install @ms/js-sdk

使用方法

基础用法

import MsSdk, { MsHttp, MsStorage, MsUtils, MsAuth } from '@ms/js-sdk'

// 初始化 SDK
const sdk = new MsSdk({
  baseUrl: 'https://your-api.com',
  timeout: 30000,
  apiKey: 'your-api-key'
})

HTTP 请求

const http = new MsHttp('https://api.example.com')

// GET 请求
const response = await http.get('/users')

// POST 请求
const result = await http.post('/users', {
  name: 'John',
  email: '[email protected]'
})

本地存储

const storage = new MsStorage()

// 存储数据
await storage.set('user', { name: 'John', age: 30 })

// 获取数据
const user = await storage.get('user')

// 删除数据
await storage.remove('user')

工具函数

// 格式化日期
const formatted = MsUtils.formatDate(new Date(), 'YYYY-MM-DD')

// 生成 ID
const id = MsUtils.generateId(10)

// 防抖函数
const debouncedFn = MsUtils.debounce(() => {
  console.log('Debounced!')
}, 300)

// 节流函数
const throttledFn = MsUtils.throttle(() => {
  console.log('Throttled!')
}, 1000)

用户认证

const auth = new MsAuth()

// 登录
const { token, userInfo } = await auth.login({
  username: 'john',
  password: 'password123'
})

// 检查登录状态
const isLoggedIn = await auth.isLoggedIn()

// 获取用户信息
const user = await auth.getUserInfo()

// 登出
await auth.logout()

API 文档

MsSdk

主 SDK 类，用于全局配置管理。

构造函数

• constructor(config?: MsSdkConfig)

方法

• getConfig(): MsSdkConfig - 获取当前配置
• updateConfig(newConfig: Partial<MsSdkConfig>): void - 更新配置

MsHttp

HTTP 请求模块。

方法

• get<T>(url: string, options?: HttpOptions): Promise<HttpResponse<T>>
• post<T>(url: string, data?: any, options?: HttpOptions): Promise<HttpResponse<T>>
• put<T>(url: string, data?: any, options?: HttpOptions): Promise<HttpResponse<T>>
• delete<T>(url: string, options?: HttpOptions): Promise<HttpResponse<T>>

MsStorage

本地存储模块。

方法

• set(key: string, value: any): Promise<void>
• get<T>(key: string, defaultValue?: T): Promise<T>
• remove(key: string): Promise<void>
• clear(): Promise<void>
• keys(): Promise<string[]>

MsUtils

工具函数模块。

静态方法

• formatDate(date: Date, format?: string): string
• generateId(length?: number): string
• debounce<T>(func: T, wait: number): T
• throttle<T>(func: T, limit: number): T
• deepClone<T>(obj: T): T
• isValidEmail(email: string): boolean
• isValidPhone(phone: string): boolean

MsAuth

用户认证模块。

方法

• login(params: LoginParams): Promise<{ token: string; userInfo: UserInfo }>
• logout(): Promise<void>
• getToken(): Promise<string | null>
• getUserInfo(): Promise<UserInfo | null>
• isLoggedIn(): Promise<boolean>
• refreshToken(): Promise<string>

发布到 npm

1. 构建包：npm run build
2. 发布：npm publish

许可证

MIT