Namespace helpers

Functions

readBigIntFromBuffer

readBigIntFromBuffer(buffer: Buffer, little?: boolean, signed?: boolean): bigInt.BigInteger

- Defined in gramjs/Helpers.ts:14
converts a buffer to big int

Parameters
- buffer: Buffer
- little: boolean = true
- signed: boolean = false
Returns bigInt.BigInteger

generateRandomBigInt

generateRandomBigInt(): BigInteger

- Defined in gramjs/Helpers.ts:32
Returns BigInteger

escapeRegex

escapeRegex(string: string): string

- Defined in gramjs/Helpers.ts:36
Parameters
- string: string
Returns string

groupBy

groupBy(list: any[], keyGetter: Function): Map<any, any>

- Defined in gramjs/Helpers.ts:40
Parameters
- list: any[]
- keyGetter: Function
Returns Map<any, any>

betterConsoleLog

betterConsoleLog(object: {}): {}

- Defined in gramjs/Helpers.ts:58
Outputs the object in a better way by hiding all the private methods/attributes.

Parameters
- object: {}
  
  the class to use
  - [key: string]: any
Returns {}
- [key: string]: any

isArrayLike

isArrayLike<T>(x: any): x is T[]

- Defined in gramjs/Helpers.ts:73
Helper to find if a given object is an array (or similar)

Type Parameters
- T
Parameters
- x: any
Returns x is T[]

toSignedLittleBuffer

toSignedLittleBuffer(big: string | number | BigInteger, number?: number): Buffer

- Defined in gramjs/Helpers.ts:103
Special case signed little ints

Parameters
- big: string | number | BigInteger
- number: number = 8
Returns Buffer

readBufferFromBigInt

readBufferFromBigInt(bigIntVar: BigInteger, bytesNumber: number, little?: boolean, signed?: boolean): Buffer

- Defined in gramjs/Helpers.ts:124
converts a big int to a buffer

Parameters
- bigIntVar: BigInteger
- bytesNumber: number
- little: boolean = true
- signed: boolean = false
Returns Buffer

generateRandomLong

generateRandomLong(signed?: boolean): BigInteger

- Defined in gramjs/Helpers.ts:166
Generates a random long integer (8 bytes), which is optionally signed

Parameters
- signed: boolean = true
Returns BigInteger

mod

mod(n: number, m: number): number

- Defined in gramjs/Helpers.ts:176
.... really javascript

Parameters
- n: number
- m: number
Returns number

bigIntMod

bigIntMod(n: BigInteger, m: BigInteger): bigInt.BigInteger

- Defined in gramjs/Helpers.ts:186
returns a positive bigInt

Parameters
- n: BigInteger
- m: BigInteger
Returns bigInt.BigInteger

generateRandomBytes

generateRandomBytes(count: number): Buffer

- Defined in gramjs/Helpers.ts:198
Generates a random bytes array

Parameters
- count: number
Returns Buffer

stripText

stripText(text: string, entities: TypeMessageEntity[]): string

- Defined in gramjs/Helpers.ts:229
Calculate the key based on Telegram guidelines, specifying whether it's the client or not

Parameters
- text: string
- entities: TypeMessageEntity[]
Returns string

generateKeyDataFromNonce

generateKeyDataFromNonce(serverNonceBigInt: BigInteger, newNonceBigInt: BigInteger): Promise<{ key: Buffer; iv: Buffer }>

- Defined in gramjs/Helpers.ts:274
Generates the key data corresponding to the given nonces

Parameters
- serverNonceBigInt: BigInteger
- newNonceBigInt: BigInteger
Returns Promise<{ key: Buffer; iv: Buffer }>

convertToLittle

convertToLittle(buf: Buffer): Buffer

- Defined in gramjs/Helpers.ts:297
Parameters
- buf: Buffer
Returns Buffer

sha1

sha1(data: Buffer): Promise<Buffer>

- Defined in gramjs/Helpers.ts:311
Calculates the SHA1 digest for the given data

Parameters
- data: Buffer
Returns Promise<Buffer>

sha256

sha256(data: Buffer): Promise<Buffer>

- Defined in gramjs/Helpers.ts:323
Calculates the SHA256 digest for the given data

Parameters
- data: Buffer
Returns Promise<Buffer>

modExp

modExp(a: BigInteger, b: BigInteger, n: BigInteger): bigInt.BigInteger

- Defined in gramjs/Helpers.ts:337
Fast mod pow for RSA calculation. a^b % n

Parameters
- a: BigInteger
- b: BigInteger
- n: BigInteger
Returns bigInt.BigInteger

getByteArray

getByteArray(integer: number | BigInteger, signed?: boolean): Buffer

- Defined in gramjs/Helpers.ts:364
Gets the arbitrary-length byte array corresponding to the given integer

Parameters
- integer: number | BigInteger
- signed: boolean = false
Returns Buffer

returnBigInt

returnBigInt(num: string | number | bigint | BigInteger): BigInteger

- Defined in gramjs/Helpers.ts:378
Parameters
- num: string | number | bigint | BigInteger
Returns BigInteger

getMinBigInt

getMinBigInt(arrayOfBigInts: (string | BigInteger)[]): bigInt.BigInteger

- Defined in gramjs/Helpers.ts:397
Helper function to return the smaller big int in an array

Parameters
- arrayOfBigInts: (string | BigInteger)[]
Returns bigInt.BigInteger

getRandomInt

getRandomInt(min: number, max: number): number

- Defined in gramjs/Helpers.ts:421
returns a random int from min (inclusive) and max (inclusive)

Parameters
- min: number
- max: number
Returns number

sleep

sleep(ms: number, isUnref?: boolean): Promise<unknown>

- Defined in gramjs/Helpers.ts:433
Sleeps a specified amount of time

Parameters
- ms: number
  
  time in milliseconds
- isUnref: boolean = false
  
  make a timer unref'ed
Returns Promise<unknown>

bufferXor

bufferXor(a: Buffer, b: Buffer): Buffer

- Defined in gramjs/Helpers.ts:445
Helper to export two buffers of same length

Parameters
- a: Buffer
- b: Buffer
Returns Buffer

crc32

crc32(buf: string | Buffer): number

- Defined in gramjs/Helpers.ts:469
Parameters
- buf: string | Buffer
Returns number

_entityType

_entityType(entity: EntityLike): number

- Defined in gramjs/Helpers.ts:501
Parameters
- entity: EntityLike
Returns number

Variables

Const _EntityType

_EntityType: { USER: number; CHAT: number; CHANNEL: number } = ...

Type declaration

USER: number
CHAT: number
CHANNEL: number

Generated using TypeDoc