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

riyad

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

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

isTMA​

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

简单​

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

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

1. import { isTMA } from '@telegram-apps/bridge';
   
2. 
   
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';
   9 b% g# u% S! b5 T4 q  R/ _% h
2. 
   
3. if (await isTMA()) {
   
4.   console.log('It\'s Telegram Mini Apps');
   # N, _( V( c6 M! d6 k2 O/ w
5. }

复制代码

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

1. if (await isTMA({ timeout: 50 })) {
   % O  v2 ]. k0 i. C- q: X6 j: V6 X
2.   console.log('It\'s Telegram Mini Apps');
   ) e7 G1 y  g* `6 x
3. }

复制代码

mockTelegramEnv​

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

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

1. mockTelegramEnv({
   + [* r* a  q7 W9 I0 x
2.   themeParams: {
   4 n* O# ^3 e2 ^, V
3.     accentTextColor: '#6ab2f2',
   
4.     bgColor: '#17212b',
   
5.     buttonColor: '#5288c1',
   
6.     buttonTextColor: '#ffffff',
   : O" v# _' n9 z; N* u3 S4 C; a
7.     destructiveTextColor: '#ec3942',
   7 N0 X- A& p* o. i
8.     headerBgColor: '#17212b',
   
9.     hintColor: '#708499',
   
10.     linkColor: '#6ab3f3',
    2 D0 m! M; A4 A9 H0 P
11.     secondaryBgColor: '#232e3c',
    
12.     sectionBgColor: '#17212b',
    + C2 T1 M$ n( O$ T+ e4 ^2 \8 ?- _
13.     sectionHeaderTextColor: '#6ab3f3',
    
14.     subtitleTextColor: '#708499',
    
15.     textColor: '#f5f5f5',
    
16.   },
    3 }, i2 j. y! M0 u" `1 ]. m0 V
17.   initData: {
    
18.     user: {
    2 M7 S  ?6 G) d
19.       id: 99281932,
    
20.       firstName: 'Andrew',
    
21.       lastName: 'Rogue',
    " Q8 Q2 d: p# x3 P) t
22.       username: 'rogue',
    0 b& B/ G9 E$ g$ ^
23.       languageCode: 'en',
    # V* n* k. \% s" X
24.       isPremium: true,
    
25.       allowsWriteToPm: true,
    
26.     },
    4 w$ o5 G* v0 Y. P
27.     hash: '89d6079ad6762351f38c6dbbc41bb53048019256a9443988af7a48bcad16ba31',
    & t0 _' |" A' {' N
28.     authDate: new Date(1716922846000),
    
29.     startParam: 'debug',
    # G) z' I3 p/ [( D( e% w
30.     chatType: 'sender',
    
31.     chatInstance: '8428209589180549439',
    3 ~: }/ [" w2 p  y
32.   },
    
33.   initDataRaw: new URLSearchParams([
    
34.     ['user', JSON.stringify({
    
35.       id: 99281932,
    ) j2 N0 s4 R1 J
36.       first_name: 'Andrew',
    8 Z& j4 f' k. d( K$ H
37.       last_name: 'Rogue',
    
38.       username: 'rogue',
    & J- E9 j% S+ ^- D: B: n
39.       language_code: 'en',
    
40.       is_premium: true,
    7 |: N: W1 q; {, U" w
41.       allows_write_to_pm: true,
    
42.     })],
    
43.     ['hash', '89d6079ad6762351f38c6dbbc41bb53048019256a9443988af7a48bcad16ba31'],
    
44.     ['auth_date', '1716922846'],
    
45.     ['start_param', 'debug'],
    
46.     ['chat_type', 'sender'],
    ! H, b9 X5 O: z" ?
47.     ['chat_instance', '8428209589180549439'],
    . y: J$ N4 F) T* I6 {- V& ]8 ~
48.   ]).toString(),
    3 V9 X; P4 C9 t9 n1 m  t! R
49.   version: '7.2',
    
50.   platform: 'tdesktop',
    0 z) `' x% V( _8 w* i* ^/ m- W
51. });

复制代码

WARNING

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

, Q, T2 Q! ~: ?. M" X1 B