GramIO API Reference / gramio/dist / TelegramError

Class: TelegramError<T>

Defined in: gramio/index.d.ts:20

Represent TelegramAPIResponseError and thrown in API calls

Extends

• Error

Type Parameters

Type Parameter
T extends keyof APIMethods

Constructors

Constructor

new TelegramError<T>(error, method, params, callSite?): TelegramError<T>

Defined in: gramio/index.d.ts:30

Construct new TelegramError

Parameters

Parameter	Type
error	TelegramAPIResponseError
method	T
params	MaybeSuppressedParams<T>
callSite?	Error

Returns

TelegramError<T>

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
cause?	public	unknown	-	Error.cause	typescript/lib/lib.es2022.error.d.ts:26
code	public	number	See TelegramAPIResponseError.error_code	-	gramio/index.d.ts:26
message	public	string	-	Error.message	typescript/lib/lib.es5.d.ts:1077
method	public	T	Name of the API Method	-	gramio/index.d.ts:22
name	public	string	-	Error.name	typescript/lib/lib.es5.d.ts:1076
params	public	MaybeSuppressedParams<T>	Params that were sent	-	gramio/index.d.ts:24
payload?	public	TelegramResponseParameters	Describes why a request was unsuccessful.	-	gramio/index.d.ts:28
stack?	public	string	-	Error.stack	typescript/lib/lib.es5.d.ts:1078
stackTraceLimit	static	number	The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)). The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	Error.stackTraceLimit	@types/node/globals.d.ts:67

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: @types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: @types/node/globals.d.ts:55

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace