Interface IEnvironment

Represents the client environment in which the application is running.

interface IEnvironment {
    getBrowser(): string;
    getClientEnvironment(): string & {} | "web" | "miniapp";
    getLocale(): string;
    getPlatform(): string;
    getTelegramUser(): undefined | TelegramUser;
}

Index

Methods

getBrowser getClientEnvironment getLocale getPlatform getTelegramUser

Methods

getBrowser

getBrowser(): string
Retrieves the name or identifier of the user's browser.

Returns string
- Defined in packages/sdk/lib/types/index.d.ts:546

getClientEnvironment

getClientEnvironment(): string & {} | "web" | "miniapp"
Retrieves the type of client environment. Indicates whether the client is running as a web application, Telegram Mini App, or another custom environment.

Returns string & {} | "web" | "miniapp"
- Defined in packages/sdk/lib/types/index.d.ts:560

getLocale

getLocale(): string
Retrieves the user's current locale setting.

Returns string
- Defined in packages/sdk/lib/types/index.d.ts:542

getPlatform

getPlatform(): string
Retrieves the name of the user's operating system or platform.

Returns string
- Defined in packages/sdk/lib/types/index.d.ts:550

getTelegramUser

getTelegramUser(): undefined | TelegramUser
Retrieves the Telegram user associated with the current environment, if available.

Returns undefined | TelegramUser
- Defined in packages/sdk/lib/types/index.d.ts:554