UNPKG

@telegram-apps/bridge

Version:

TypeScript package to provide communication layer between Mini App and Telegram application.

23 lines (22 loc) 1.07 kB
import { MethodNameWithOptionalParams, MethodNameWithoutParams, MethodNameWithRequiredParams, MethodParams } from './types/index.js'; export type PostEventFn = typeof postEvent; /** * Calls Mini Apps methods requiring parameters. * @param method - method name. * @param params - options along with params. * @throws {UnknownEnvError} The environment is unknown. */ export declare function postEvent<Method extends MethodNameWithRequiredParams>(method: Method, params: MethodParams<Method>): void; /** * Calls Mini Apps methods accepting no parameters at all. * @param method - method name. * @throws {UnknownEnvError} The environment is unknown. */ export declare function postEvent(method: MethodNameWithoutParams): void; /** * Calls Mini Apps methods accepting optional parameters. * @param method - method name. * @param params - options along with params. * @throws {UnknownEnvError} The environment is unknown. */ export declare function postEvent<Method extends MethodNameWithOptionalParams>(method: Method, params?: MethodParams<Method>): void;