@doubao-apps/create 0.0.25 → 0.0.27

package/dist/template-starter/.ai/reference/open-api/02-/345/255/230/345/202/250.md

@@ -0,0 +1,409 @@
+# Open API: 存储
+
+本地缓存；带 Sync 后缀的是同步 API。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [setStorage](#setstorage) | 将数据写入本地缓存。 |
+| [setStorageSync](#setstoragesync) | 将数据写入本地缓存。<br><br>同步 API。 |
+| [getStorage](#getstorage) | 从本地缓存读取数据。 |
+| [getStorageSync](#getstoragesync) | 从本地缓存同步读取数据。<br><br>同步 API。 |
+| [removeStorage](#removestorage) | 删除本地缓存中指定 key 的数据。 |
+| [removeStorageSync](#removestoragesync) | 删除本地缓存中指定 key 的数据。<br><br>同步 API。 |
+| [clearStorage](#clearstorage) | 清空本地缓存。 |
+| [clearStorageSync](#clearstoragesync) | 清空本地缓存。<br><br>同步 API。 |
+| [getStorageInfo](#getstorageinfo) | 获取本地缓存信息。 |
+| [getStorageInfoSync](#getstorageinfosync) | 同步获取本地缓存信息。<br><br>同步 API。 |
+
+## API 详情
+
+<a id="setstorage"></a>
+### setStorage()
+
+> **setStorage**\<`TData`\>(`params`): `Promise`\<`object`\>
+
+将数据写入本地缓存。
+
+#### Type parameters
+
+• **TData** = `unknown`
+
+#### Parameters
+
+• **params**: [`SetStorageParams`](#setstorageparamstdata)\<`TData`\>
+
+存储参数，字段见 [SetStorageParams](#setstorageparamstdata)。
+
+#### Returns
+
+`Promise`\<`object`\>
+
+返回一个 Promise，写入完成后 resolve。
+
+#### Remarks
+
+#### Example
+
+```typescript
+import { setStorage } from '@doubao-apps/framework/api';
+
+await setStorage({
+  key: 'profile',
+  data: { name: 'Tom', age: 18 },
+});
+```
+
+<a id="setstoragesync"></a>
+### setStorageSync()
+
+> **setStorageSync**\<`TData`\>(`params`): `object`
+
+将数据写入本地缓存。
+
+#### Type parameters
+
+• **TData** = `unknown`
+
+#### Parameters
+
+• **params**: [`SetStorageParams`](#setstorageparamstdata)\<`TData`\>
+
+存储参数，字段见 [SetStorageParams](#setstorageparamstdata)。
+
+#### Returns
+
+`object`
+
+同步写入完成后返回。
+
+#### Remarks
+
+#### Example
+
+```typescript
+import { setStorageSync } from '@doubao-apps/framework/api';
+
+setStorageSync({
+  key: 'profile',
+  data: { name: 'Tom', age: 18 },
+});
+```
+
+<a id="getstorage"></a>
+### getStorage()
+
+> **getStorage**\<`TData`\>(`params`): `Promise`\<[`GetStorageResult`](#getstorageresulttdata)\<`TData`\>\>
+
+从本地缓存读取数据。
+
+#### Type parameters
+
+• **TData** = `unknown`
+
+#### Parameters
+
+• **params**: [`GetStorageParams`](#getstorageparams)
+
+查询参数，字段见 [GetStorageParams](#getstorageparams)。
+
+#### Returns
+
+`Promise`\<[`GetStorageResult`](#getstorageresulttdata)\<`TData`\>\>
+
+返回一个 Promise，解析为 [GetStorageResult](#getstorageresulttdata)。
+
+#### Remarks
+
+#### Example
+
+```typescript
+import { getStorage } from '@doubao-apps/framework/api';
+
+const result = await getStorage<{ name: string; age: number }>({
+  key: 'profile',
+});
+
+console.log(result.data.name, result.data.age);
+```
+
+<a id="getstoragesync"></a>
+### getStorageSync()
+
+> **getStorageSync**\<`TData`\>(`params`): [`GetStorageResult`](#getstorageresulttdata)\<`TData`\>
+
+从本地缓存同步读取数据。
+
+#### Type parameters
+
+• **TData** = `unknown`
+
+#### Parameters
+
+• **params**: [`GetStorageParams`](#getstorageparams)
+
+查询参数，字段见 [GetStorageParams](#getstorageparams)。
+
+#### Returns
+
+[`GetStorageResult`](#getstorageresulttdata)\<`TData`\>
+
+返回 [GetStorageResult](#getstorageresulttdata)。
+
+#### Remarks
+
+#### Example
+
+```typescript
+import { getStorageSync } from '@doubao-apps/framework/api';
+
+const result = getStorageSync<{ name: string; age: number }>({
+  key: 'profile',
+});
+
+console.log(result.data.name, result.data.age);
+```
+
+<a id="removestorage"></a>
+### removeStorage()
+
+> **removeStorage**(`params`): `Promise`\<`object`\>
+
+删除本地缓存中指定 key 的数据。
+
+#### Parameters
+
+• **params**: [`RemoveStorageParams`](#removestorageparams)
+
+删除参数，字段见 [RemoveStorageParams](#removestorageparams)。
+
+#### Returns
+
+`Promise`\<`object`\>
+
+返回一个 Promise，删除完成后 resolve。
+
+#### Example
+
+```typescript
+import { removeStorage } from '@doubao-apps/framework/api';
+
+await removeStorage({ key: 'profile' });
+```
+
+<a id="removestoragesync"></a>
+### removeStorageSync()
+
+> **removeStorageSync**(`params`?): `object`
+
+删除本地缓存中指定 key 的数据。
+
+#### Parameters
+
+• **params?**: [`RemoveStorageParams`](#removestorageparams)
+
+删除参数，字段见 [RemoveStorageParams](#removestorageparams)。
+
+#### Returns
+
+`object`
+
+同步删除完成后返回。
+
+#### Example
+
+```typescript
+import { removeStorageSync } from '@doubao-apps/framework/api';
+
+removeStorageSync({ key: 'profile' });
+```
+
+<a id="clearstorage"></a>
+### clearStorage()
+
+> **clearStorage**(`params`?): `Promise`\<`object`\>
+
+清空本地缓存。
+
+#### Parameters
+
+• **params?**: `object`
+
+#### Returns
+
+`Promise`\<`object`\>
+
+返回一个 Promise，清空完成后 resolve。
+
+#### Example
+
+```typescript
+import { clearStorage } from '@doubao-apps/framework/api';
+
+await clearStorage();
+```
+
+<a id="clearstoragesync"></a>
+### clearStorageSync()
+
+> **clearStorageSync**(`params`?): `object`
+
+清空本地缓存。
+
+#### Parameters
+
+• **params?**: `object`
+
+#### Returns
+
+`object`
+
+同步清空完成后返回。
+
+#### Example
+
+```typescript
+import { clearStorageSync } from '@doubao-apps/framework/api';
+
+clearStorageSync();
+```
+
+<a id="getstorageinfo"></a>
+### getStorageInfo()
+
+> **getStorageInfo**(`params`?): `Promise`\<[`GetStorageInfoResult`](#getstorageinforesult)\>
+
+获取本地缓存信息。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetStorageInfoResult`](#getstorageinforesult)\>
+
+返回一个 Promise，解析为 [GetStorageInfoResult](#getstorageinforesult)。
+
+#### Example
+
+```typescript
+import { getStorageInfo } from '@doubao-apps/framework/api';
+
+const result = await getStorageInfo();
+
+console.log(result.keys, result.currentSize, result.limitSize);
+```
+
+<a id="getstorageinfosync"></a>
+### getStorageInfoSync()
+
+> **getStorageInfoSync**(`params`?): [`GetStorageInfoResult`](#getstorageinforesult)
+
+同步获取本地缓存信息。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+[`GetStorageInfoResult`](#getstorageinforesult)
+
+返回 [GetStorageInfoResult](#getstorageinforesult)。
+
+#### Example
+
+```typescript
+import { getStorageInfoSync } from '@doubao-apps/framework/api';
+
+const result = getStorageInfoSync();
+
+console.log(result.keys, result.currentSize, result.limitSize);
+```
+
+## 相关类型
+
+<a id="setstorageparamstdata"></a>
+### SetStorageParams<TData>
+
+#### Type parameters
+
+• **TData** = `unknown`
+
+#### Properties
+
+##### data
+
+> **data**: `TData`
+
+待存储的数据
+
+##### key
+
+> **key**: `string`
+
+本地缓存键名
+
+<a id="getstorageparams"></a>
+### GetStorageParams
+
+#### Properties
+
+##### key
+
+> **key**: `string`
+
+本地缓存键名
+
+<a id="getstorageresulttdata"></a>
+### GetStorageResult<TData>
+
+#### Type parameters
+
+• **TData** = `unknown`
+
+#### Properties
+
+##### data
+
+> **data**: `TData`
+
+key 对应的数据
+
+<a id="removestorageparams"></a>
+### RemoveStorageParams
+
+#### Properties
+
+##### key
+
+> **key**: `string`
+
+本地缓存键名
+
+<a id="getstorageinforesult"></a>
+### GetStorageInfoResult
+
+#### Properties
+
+##### currentSize
+
+> **currentSize**: `number`
+
+当前占用的空间大小，单位 KB
+
+##### keys
+
+> **keys**: `string`[]
+
+当前 storage 中所有的 key
+
+##### limitSize
+
+> **limitSize**: `number`
+
+限制的空间大小，单位 KB

package/dist/template-starter/.ai/reference/open-api/03-/350/267/257/347/224/261.md

@@ -0,0 +1,165 @@
+# Open API: 路由
+
+应用内页面跳转和关闭。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [close](#close) | 关闭栈顶页面。<br><br>已废弃，使用 navigateBack。 |
+| [navigateTo](#navigateto) | 保留当前页面，跳转到应用内的某个页面。 |
+| [redirectTo](#redirectto) | 关闭当前页面，跳转到应用内的某个页面。 |
+| [reLaunch](#relaunch) | 关闭所有页面并跳转到应用内页面。 |
+| [navigateBack](#navigateback) | 关闭当前页面，返回上一页面或多级页面。 |
+| [exitApp](#exitapp) | 退出当前所有页面。<br><br>会退出当前所有页面。 |
+
+## API 详情
+
+<a id="close"></a>
+### close()
+
+> **close**(`params`?): `Promise`\<`object`\>
+
+关闭栈顶页面。
+
+#### Parameters
+
+• **params?**: [`CloseParams`](#closeparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+返回一个 Promise，在关闭操作成功发起时解析
+
+#### Deprecated
+
+使用 [navigateBack](#navigateback)
+
+#### Example
+
+```typescript
+import { close } from '@doubao-apps/framework/api';
+
+async function closeTopPage() {
+  try {
+    await close();
+  } catch (e) {
+    console.error('关闭页面失败', e);
+  }
+}
+
+closePage();
+```
+
+<a id="navigateto"></a>
+### navigateTo()
+
+> **navigateTo**(`params`): `Promise`\<`object`\>
+
+保留当前页面，跳转到应用内的某个页面。
+
+#### Parameters
+
+• **params**: [`NavigateToParams`](#navigatetoparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="redirectto"></a>
+### redirectTo()
+
+> **redirectTo**(`params`): `Promise`\<`object`\>
+
+关闭当前页面，跳转到应用内的某个页面。
+
+#### Parameters
+
+• **params**: [`NavigateToParams`](#navigatetoparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="relaunch"></a>
+### reLaunch()
+
+> **reLaunch**(`params`): `Promise`\<`object`\>
+
+关闭所有页面并跳转到应用内页面。
+
+#### Parameters
+
+• **params**: [`NavigateToParams`](#navigatetoparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="navigateback"></a>
+### navigateBack()
+
+> **navigateBack**(`params`?): `Promise`\<`object`\>
+
+关闭当前页面，返回上一页面或多级页面。
+
+#### Parameters
+
+• **params?**: [`NavigateBackParams`](#navigatebackparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="exitapp"></a>
+### exitApp()
+
+> **exitApp**(): `Promise`\<`object`\>
+
+退出当前所有页面。
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+会退出当前所有页面。
+
+## 相关类型
+
+<a id="closeparams"></a>
+### CloseParams
+
+#### Properties
+
+##### containerID?
+
+> `optional` **containerID**: `string`
+
+指定一个要关闭的页面
+
+<a id="navigatetoparams"></a>
+### NavigateToParams
+
+#### Properties
+
+##### url
+
+> **url**: `string`
+
+跳转的页面的路径，如 'path?key=value&key2=value2'
+
+<a id="navigatebackparams"></a>
+### NavigateBackParams
+
+#### Properties
+
+##### delta?
+
+> `optional` **delta**: `number`
+
+返回的页面数，如果 delta 大于现有页面数，则返回到页面栈中只剩一个页面为止。