docs: update docs for blocklet sdk

blocklet · Jul 11, 2023 · fd393b2 · fd393b2
1 parent b78166b
commit fd393b2
Show file tree

Hide file tree

Showing 8 changed files with 39 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.1.134 (July 11, 2023)
+
+- docs: update docs for blocklet sdk
+
 ## 0.1.133 (June 29, 2023)
 
 - docs: update docs for "develop component"

diff --git a/developer/docs/blocklet.yml b/developer/docs/blocklet.yml
@@ -14,7 +14,7 @@ repository:
   type: git
   url: git+https://github.com/blocklet/blocklet-site.git
 specVersion: 1.2.8
-version: 0.1.133
+version: 0.1.134
 logo: logo.png
 files:
   - hooks/post-start.js

diff --git a/developer/docs/pages/reference/blocklet-sdk/index.md b/developer/docs/pages/reference/blocklet-sdk/index.md
@@ -489,7 +489,6 @@ const {
   appName, // the title of the app, used to display to user
   appDescription, // the description of the app
   appUrl, // the web url of the app
-  isComponent, // the blocklet is running as an app or a component
   dataDir, // the data dir of the blocklet
   cacheDir, // the cache dir of the blocklet
   mode, // in which mode the blocklet is running
@@ -519,6 +518,18 @@ import { env, components } from '@blocklet/config'
 ```
 
 - `env` same as env in Environment
+  - `appId` the did of the app
+  - `appPid` the permenant did of the app
+  - `appIds` all did's that the application has previously used
+  - `appName` the title of the app, used to display to user
+  - `appDescription` the description of the app
+  - `appUrl` the web url of the app
+  - `dataDir` the data dir of the blocklet
+  - `cacheDir` the cache dir of the blocklet
+  - `mode` in which mode the blocklet is running
+  - `appStorageEndpoint` the endpoint of the DID Spaces of the app
+  - `serverVersion` the version of the server where the app is running
+  - `preferences` blocklet preferences. default: {}
 - `components` **Array\<object\>**
   - `title` component title
   - `did` component did

diff --git a/developer/docs/pages/reference/blocklet-sdk/index.zh.md b/developer/docs/pages/reference/blocklet-sdk/index.zh.md
@@ -489,13 +489,12 @@ const {
   appName, // 应用名称，用于显示给用户
   appDescription, // 应用描述，用于显示给用户
   appUrl, // 应用的的访问地址
-  isComponent, // Blocklet 当前作为应用运行还是作为组件运行
-  dataDir, // Blocklet 数据存放目录
-  cacheDir, // Blocklet 缓存数据路径
-  mode, // Blocklet 以什么模式运行
-  appStorageEndpoint // 应用运行所在server的版本
-  serverVersion: // 应用绑定的 DID Space 的 endpoint
-  preferences, // Blocklet 的偏好设置。默认值: {}
+  dataDir, // 组件 数据存放目录
+  cacheDir, // 组件 缓存数据路径
+  mode, // 组件 以什么模式运行
+  appStorageEndpoint // 应用绑定的 DID Space 的 endpoint
+  serverVersion: // 应用运行所在server的版本
+  preferences, // 应用的偏好设置。默认值: {}
 } = env;
 ```
 
@@ -519,6 +518,18 @@ import { env, components } from '@blocklet/config'
 ```
 
 - `env` Environment 中的 env 相同
+  - `appId` 应用 DID
+  - `appPid` 应用永久 DID
+  - `appIds` 应用曾使用过的所有 DID
+  - `appName` 应用名称，用于显示给用户
+  - `appDescription` 应用描述，用于显示给用户
+  - `appUrl` 应用的的访问地址
+  - `dataDir` Blocklet 数据存放目录
+  - `cacheDir` Blocklet 缓存数据路径
+  - `mode` Blocklet 以什么模式运行
+  - `appStorageEndpoint` 应用绑定的 DID Space 的 endpoint
+  - `serverVersion` 应用运行所在server的版本
+  - `preferences` 应用 的偏好设置。默认值: {}
 - `components` **Array\<object\>**
   - `title` 组件名称
   - `did` 组件 DID

diff --git a/developer/pages/blocklet.yml b/developer/pages/blocklet.yml
@@ -13,7 +13,7 @@ repository:
   type: git
   url: git+https://github.com/blocklet/blocklet-site.git
 specVersion: 1.2.8
-version: 0.1.133
+version: 0.1.134
 logo: logo.png
 files: []
 interfaces:

diff --git a/version b/version
@@ -1 +1 @@
-0.1.133
+0.1.134
diff --git a/website/docs/blocklet.yml b/website/docs/blocklet.yml
@@ -14,7 +14,7 @@ repository:
   type: git
   url: git+https://github.com/blocklet/blocklet-site.git
 specVersion: 1.2.8
-version: 0.1.133
+version: 0.1.134
 logo: logo.png
 files: []
 interfaces:

diff --git a/website/pages/blocklet.yml b/website/pages/blocklet.yml
@@ -13,7 +13,7 @@ repository:
   type: git
   url: git+https://github.com/blocklet/blocklet-site.git
 specVersion: 1.2.8
-version: 0.1.133
+version: 0.1.134
 logo: logo.png
 files: []
 interfaces: