GramIO API Reference / @gramio/init-data/dist
@gramio/init-data/dist
Interfaces
| Interface | Description |
|---|---|
| WebAppChat | This object represents a chat. |
| WebAppInitData | This object contains data that is transferred to the Mini App when it is opened. It is empty if the Mini App was launched from a keyboard button or from inline mode. |
Type Aliases
| Type Alias | Description |
|---|---|
| MakeOptional | - |
| Optional | - |
| WebAppChatType | Known type of chat. |
| WebAppUser | This object contains the data of the Mini App user. |
Variables
sha256Hash()
constsha256Hash: (hmacKey,input,encoding?) =>string
Defined in: init-data/index.d.ts:142
Parameters
| Parameter | Type |
|---|---|
hmacKey | string | Buffer |
input | string |
encoding? | BinaryToTextEncoding |
Returns
string
Functions
getBotTokenSecretKey()
getBotTokenSecretKey(
botToken):Buffer<ArrayBufferLike>
Defined in: init-data/index.d.ts:143
Parameters
| Parameter | Type |
|---|---|
botToken | string |
Returns
Buffer<ArrayBufferLike>
parseInitData()
parseInitData(
query):WebAppInitData
Defined in: init-data/index.d.ts:146
Parameters
| Parameter | Type |
|---|---|
query | string |
Returns
parseJSON()
parseJSON<
T>(value):T
Defined in: init-data/index.d.ts:141
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
value | string |
Returns
T
serializeInitData()
serializeInitData(
data):URLSearchParams
Defined in: init-data/index.d.ts:144
Parameters
| Parameter | Type |
|---|---|
data | MakeOptional<WebAppInitData, "hash" | "auth_date"> |
Returns
URLSearchParams
signInitData()
Call Signature
signInitData(
initData,secretKeyOrToken):string
Defined in: init-data/index.d.ts:150
Parameters
| Parameter | Type |
|---|---|
initData | string |
secretKeyOrToken | string | Buffer<ArrayBufferLike> |
Returns
string
Call Signature
signInitData(
initData,secretKeyOrToken):string
Defined in: init-data/index.d.ts:151
Parameters
| Parameter | Type |
|---|---|
initData | MakeOptional<WebAppInitData, "hash" | "auth_date"> |
secretKeyOrToken | string | Buffer<ArrayBufferLike> |
Returns
string
validateAndParseInitData()
validateAndParseInitData(
query,token):false|WebAppInitData
Defined in: init-data/index.d.ts:148
Parameters
| Parameter | Type |
|---|---|
query | string |
token | string | Buffer<ArrayBufferLike> |
Returns
false | WebAppInitData
validateInitData()
validateInitData(
webAppInitData,token):boolean
Defined in: init-data/index.d.ts:147
Parameters
| Parameter | Type |
|---|---|
webAppInitData | string |
token | string | Buffer<ArrayBufferLike> |
Returns
boolean