Telegram 小程序 | TypeScript @telegram-apps/bridge | 环境

riyad

' z/ L; Z9 C* G
4 S  ~# p- ~" M" ?! B# V

此软件包只能在 Telegram 应用程序中使用。 由于非 Telegram 环境缺乏 Telegram 特有的特性，调用 retrieveLaunchParams 或 [postEvent 等方法将导致 错误。

不过，该软件包提供的实用工具可以帮助开发人员在 Telegram 之外开发应用程序 ，或者确定当前环境是否根本不是 Telegram 迷你应用程序。

isTMA​

要检查当前环境是否为 Telegram 迷你应用程序，开发人员可以使用 isTMA 函数。 它有两种工作模式：简单 和 完整。

简单​

在这种模式下，函数会尝试从环境中获取启动参数。

如果提取成功，该环境将被视为 Telegram 迷你应用程序。 简单模式是同步模式，返回一个布尔值。

1. import { isTMA } from '@telegram-apps/bridge';
   
2. 
   1 z3 X% n( a* Z* R  \. x' ?0 T' y
3. if (isTMA('simple')) {
   
4.   console.log('It\'s Telegram Mini Apps');
   
5. }

复制代码

这种模式略显肤浅，但仍可满足大多数应用的需要。 要进行更 可靠的检查，请使用 [color=var(--vp-c-brand-1)]complete 模式。

完整​

在这种模式下，函数会调用 Telegram Mini Apps 特有的方法，并等待 方法特有的事件发生。

1. import { isTMA } from '@telegram-apps/bridge';
   
2. 
   
3. if (await isTMA()) {
   3 {4 M$ h9 ~# R0 M7 G% d
4.   console.log('It\'s Telegram Mini Apps');
   
5. }

复制代码

函数等待事件的时间为 100 毫秒，但开发人员可以通过传递带有 timeout: number 属性的对象来更改时间 。

1. if (await isTMA({ timeout: 50 })) {
   
2.   console.log('It\'s Telegram Mini Apps');
   
3. }

复制代码

mockTelegramEnv​

该软件包提供了 mockTelegramEnv 函数，可模仿 Telegram 提供的环境。 它可以帮助开发人员在 [color=var(--vp-c-brand-1)]BotFather 中创建小应用程序记录，甚至无需创建记录即可开始构建应用程序。

该函数接受原始或解析格式的发射参数。 下面就是一个例子：

1. mockTelegramEnv({
   
2.   themeParams: {
   
3.     accentTextColor: '#6ab2f2',
   
4.     bgColor: '#17212b',
   " S1 q: \4 K7 c7 o
5.     buttonColor: '#5288c1',
   $ ^$ t- a: I2 ~5 ~# G
6.     buttonTextColor: '#ffffff',
   
7.     destructiveTextColor: '#ec3942',
   ; R' ^& ^) a6 c; Y
8.     headerBgColor: '#17212b',
   8 ^: x. l7 f* D& a/ T
9.     hintColor: '#708499',
   
10.     linkColor: '#6ab3f3',
    ) a5 e% E" [7 D( I7 Q: A
11.     secondaryBgColor: '#232e3c',
    
12.     sectionBgColor: '#17212b',
    
13.     sectionHeaderTextColor: '#6ab3f3',
    
14.     subtitleTextColor: '#708499',
    7 o2 n' N! E: ]4 n, |+ O: _4 Y0 v6 O3 U
15.     textColor: '#f5f5f5',
    
16.   },
    
17.   initData: {
    
18.     user: {
    
19.       id: 99281932,
    
20.       firstName: 'Andrew',
    & ^( a# F) _) U* B" Z- a
21.       lastName: 'Rogue',
    
22.       username: 'rogue',
    + x$ n9 ?! f( v3 n
23.       languageCode: 'en',
    
24.       isPremium: true,
    ) B! z8 o0 Z" c1 A) Z
25.       allowsWriteToPm: true,
    
26.     },
    % P5 U+ ~& Y$ S' |
27.     hash: '89d6079ad6762351f38c6dbbc41bb53048019256a9443988af7a48bcad16ba31',
    6 v. G( \5 D9 P! i. [
28.     authDate: new Date(1716922846000),
    ! }2 x$ P1 O6 b% I. t, o
29.     startParam: 'debug',
    8 C1 Y1 M2 n- d( R; K* Q8 [3 r
30.     chatType: 'sender',
    
31.     chatInstance: '8428209589180549439',
    
32.   },
    & I1 C# R' n7 b) e+ ]' r' Z
33.   initDataRaw: new URLSearchParams([
    " J% n" I7 ]- r* l
34.     ['user', JSON.stringify({
    ' T* p. q2 \+ N2 G' o
35.       id: 99281932,
    
36.       first_name: 'Andrew',
    
37.       last_name: 'Rogue',
    0 v; \; X- y8 |7 w4 j3 Q7 U, [! H
38.       username: 'rogue',
    
39.       language_code: 'en',
    / J/ D! Z1 X: {) P
40.       is_premium: true,
    
41.       allows_write_to_pm: true,
    
42.     })],
    
43.     ['hash', '89d6079ad6762351f38c6dbbc41bb53048019256a9443988af7a48bcad16ba31'],
    + K. H+ c4 R3 y2 I7 [4 k* L
44.     ['auth_date', '1716922846'],
    
45.     ['start_param', 'debug'],
    9 u2 Q$ a4 l0 y8 @& o
46.     ['chat_type', 'sender'],
    
47.     ['chat_instance', '8428209589180549439'],
    
48.   ]).toString(),
    
49.   version: '7.2',
    ) D: ^* a4 e  c/ J7 P1 [
50.   platform: 'tdesktop',
    1 M2 N6 g: v$ U( d" z
51. });

复制代码

WARNING

该函数仅模仿 Telegram 环境行为。 它不会发送任何真正的 请求，也不会执行只能在 Telegram 应用程序中看到的操作。