Skip to content

云存储

负责管理 Telegram 迷你应用程序中云存储的💠组件

检查支持

要检查当前 Telegram 迷你应用程序版本是否支持云存储,需要使用 isSupported 方法:

ts
import { cloudStorage } from '@telegram-apps/sdk';

cloudStorage.isSupported(); // boolean
ts
import { isCloudStorageSupported } from '@telegram-apps/sdk';

isCloudStorageSupported(); // boolean

设置项目

要设置键值,请使用 setItem 方法。

ts
await cloudStorage.setItem('a', 'a-value');
ts
import { setCloudStorageItem } from '@telegram-apps/sdk';

await setCloudStorageItem('a', 'a-value');

获取钥匙

要获取所有现有密钥的列表,请使用 getKeys 方法。

ts
const keys = await cloudStorage.getKeys(); // ['a', 'b', 'c']
ts
import { getCloudStorageKeys } from '@telegram-apps/sdk';

const keys = await getCloudStorageKeys(); // ['a', 'b', 'c']

要获取特定键或多个键的值,请使用 getItem 方法。

ts
const nonExistent = await cloudStorage.getItem('non-existent');
// The result is an empty string: ''

const existent = await cloudStorage.getItem('a');
// The result is the value of the 'a' key. Example: 'a-value'

const values = await cloudStorage.getItem(['a', 'b', 'non-existent']);
// The result is a record of the keys 'a', 'b', and 'non-existent'. 
// Example:
// { 
//   a: 'a-value', 
//   b: 'b-value', 
//   'non-existent': '', 
// }
ts
import { getCloudStorageItem } from '@telegram-apps/sdk';

const nonExistent = await getCloudStorageItem('non-existent');
// The result is an empty string: ''

const existent = await getCloudStorageItem('a');
// The result is the value of the 'a' key. Example: 'a-value'

const values = await getCloudStorageItem(['a', 'b', 'non-existent']);
// The result is a record of the keys 'a', 'b', and 'non-existent'. 
// Example:
// { 
//   a: 'a-value', 
//   b: 'b-value', 
//   'non-existent': '', 
// }

删除项目

要删除一个键或键列表,请使用 deleteItem 方法。

ts
await cloudStorage.deleteItem('a');
await cloudStorage.deleteItem(['a', 'b', 'c']);
ts
import { deleteCloudStorageItem } from '@telegram-apps/sdk';

await deleteCloudStorageItem('a');
await deleteCloudStorageItem(['a', 'b', 'c']);

Released under the MIT License.