SDK 概要

mini-sdk は MiniDev Studio の中核 SDK であり、ミニプログラムの実行時に必要なクライアント API をすべて提供します。開発者はデフォルトエクスポートされた woo オブジェクトを通じて各機能を呼び出します。

インストールとインポート

SDK は MiniDev Studio ランタイムに同梱されており、追加のインストールは不要です。次のように直接インポートします。

import woo from 'mini-sdk'

// 或按命名空间导入
import { router, network, storage, ui, lifecycle } from 'mini-sdk'

API 分類の概要

名前空間	説明	よく使うメソッド
Router	ページのルーティングと遷移	navigateTo navigateBack reLaunch
Network	ネットワークリクエスト	request request.get request.post
Storage	ローカルデータの保存	setStorage getStorage removeStorage
UI	画面操作とフィードバック	showToast showDialog showLoading
Lifecycle	ページのライフサイクル	onLoad onShow onHide onUnload
Clipboard	クリップボード操作	setClipboard getClipboard
Device	デバイス機能	getSystemInfo scanCode getLocation
Auth	認証・認可	requestSSOLogin getUserProfile
Analytics	データ分析	recordEvent enableAutoAnalytics
Vehicle	車両情報	getCurrentVehicleProfile getCurrentVehicleStatus
Map	地図操作	createMapContext
Component	コンポーネント操作	createVideoContext createSelectorQuery
App	アプリレベルの API	getLaunchOptionsSync onAppShow

呼び出し方

すべての API は Promise と Callback の両方の呼び出し方をサポートします。

Promise 方式（推奨）

try {
  const result = await woo.getStorage({ key: 'userToken' })
  console.log(result.data)
} catch (err) {
  console.error('获取失败：', err.message)
}

Callback 方式

woo.getStorage({
  key: 'userToken',
  success(result) {
    console.log(result.data)
  },
  fail(err) {
    console.error('获取失败：', err.message)
  },
  complete() {
    console.log('请求完成')
  },
})

ApiCallbacks 型定義

interface ApiCallbacks<T = unknown> {
  success?: (res: T) => void
  fail?: (err: BridgeError) => void
  complete?: () => void
}

woo グローバルオブジェクト

woo は全名前空間のメソッドを束ねたフラットなオブジェクトです。次の 2 つの書き方は同じ意味です。

// 通过 woo 调用
woo.navigateTo({ url: '/pages/detail/index' })

// 通过命名空间调用
import { router } from 'mini-sdk'
router.navigateTo({ url: '/pages/detail/index' })

中核のエクスポート

API メソッドに加え、SDK は次の中核機能もエクスポートします。

// Bridge 实例与构造器
export { bridge, Bridge } from 'mini-sdk'

// 环境检测
export { detectEnv, isSimulator, isNative } from 'mini-sdk'

// Transport 层
export { createTransport } from 'mini-sdk'

// 错误处理
export { setErrorHandler, getErrorMessage, BridgeErrorCode } from 'mini-sdk'

型のエクスポート

SDK は TypeScript の型定義をすべてエクスポートしており、型安全な開発が可能です。

import type {
  BridgeEnvelope,
  BridgeError,
  BridgeType,
  ApiCallbacks,
  NavigateToOptions,
  RequestOptions,
  RequestResult,
  // ... 更多类型
} from 'mini-sdk'