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

riyad

1 W( R9 v; p" ~  M" B$ h
' {3 o6 v# b) V7 R5 m$ l8 `

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

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

isTMA​

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

简单​

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

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

1. import { isTMA } from '@telegram-apps/bridge';
   / K6 D! W& h* O; D1 p% X3 _
2. 
   / w" d( h& T7 B" ^* n* B
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. 
   % d7 I" A- A( [( D* c
3. if (await isTMA()) {
   
4.   console.log('It\'s Telegram Mini Apps');
   
5. }

复制代码

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

1. if (await isTMA({ timeout: 50 })) {
   % E4 A2 q: O  ?9 B
2.   console.log('It\'s Telegram Mini Apps');
   
3. }

复制代码

mockTelegramEnv​

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

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

1. mockTelegramEnv({
   6 X# V/ k% S& _& \
2.   themeParams: {
   
3.     accentTextColor: '#6ab2f2',
   
4.     bgColor: '#17212b',
   ) f) }/ Z9 I3 ]. P0 Y5 n* |7 {5 R
5.     buttonColor: '#5288c1',
   
6.     buttonTextColor: '#ffffff',
   
7.     destructiveTextColor: '#ec3942',
     Z% E0 t& l5 x
8.     headerBgColor: '#17212b',
   1 f- \& j( }; v% k: k. j
9.     hintColor: '#708499',
   6 U0 v: \, Q( p8 N. r
10.     linkColor: '#6ab3f3',
    
11.     secondaryBgColor: '#232e3c',
    
12.     sectionBgColor: '#17212b',
    
13.     sectionHeaderTextColor: '#6ab3f3',
    
14.     subtitleTextColor: '#708499',
    
15.     textColor: '#f5f5f5',
    3 W" ]6 W3 u1 p  T# E2 ]
16.   },
    
17.   initData: {
    + }0 s3 n$ s! v
18.     user: {
    # J0 ]! c# l: K% y' p  ]" @
19.       id: 99281932,
    
20.       firstName: 'Andrew',
    
21.       lastName: 'Rogue',
    
22.       username: 'rogue',
    9 ^' ^4 x" B% x6 U- m% Y7 f
23.       languageCode: 'en',
    ' b; ~5 _- y! ]. h
24.       isPremium: true,
    5 u$ `2 s0 x8 l5 H' X. M& P
25.       allowsWriteToPm: true,
    ! \5 k1 q& X; @1 b  @3 {/ K" H
26.     },
    7 S- J) s+ ^0 Y; V+ V% B
27.     hash: '89d6079ad6762351f38c6dbbc41bb53048019256a9443988af7a48bcad16ba31',
    
28.     authDate: new Date(1716922846000),
    
29.     startParam: 'debug',
    9 w' Q+ z( r# X! C0 @' i
30.     chatType: 'sender',
    
31.     chatInstance: '8428209589180549439',
    
32.   },
    
33.   initDataRaw: new URLSearchParams([
    
34.     ['user', JSON.stringify({
    
35.       id: 99281932,
    2 f/ ]& e  l4 {, Y( r. v
36.       first_name: 'Andrew',
    ; Y; M+ b1 }2 ]) |7 c# H4 J; f
37.       last_name: 'Rogue',
    
38.       username: 'rogue',
    
39.       language_code: 'en',
    
40.       is_premium: true,
    
41.       allows_write_to_pm: true,
    
42.     })],
    
43.     ['hash', '89d6079ad6762351f38c6dbbc41bb53048019256a9443988af7a48bcad16ba31'],
    3 Y0 B1 i# V( x/ h( c; e! f
44.     ['auth_date', '1716922846'],
    2 m8 U( M/ b. V5 O
45.     ['start_param', 'debug'],
    9 n# Q( @( z& W2 w/ j. @. O
46.     ['chat_type', 'sender'],
    
47.     ['chat_instance', '8428209589180549439'],
    
48.   ]).toString(),
    6 f$ b3 @" x  p4 w+ i2 I
49.   version: '7.2',
    " V' p% I( [0 V
50.   platform: 'tdesktop',
    
51. });

复制代码

WARNING

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

3 e. j4 `6 a8 G