Documentation / @gebeta/api

@gebeta/api

Enumerations

ErrorCode

Error codes for consistent error identification across all SDKs. Organized by category with numeric suffixes for easy filtering.

Enumeration Members

Enumeration Member	Value	Defined in
API_BAD_REQUEST	"API_3001"	packages/api/src/errors/codes.ts:33
API_FORBIDDEN	"API_3003"	packages/api/src/errors/codes.ts:35
API_NOT_FOUND	"API_3004"	packages/api/src/errors/codes.ts:36
API_RATE_LIMIT	"API_3005"	packages/api/src/errors/codes.ts:37
API_SERVER_ERROR	"API_3006"	packages/api/src/errors/codes.ts:38
API_UNAUTHORIZED	"API_3002"	packages/api/src/errors/codes.ts:34
API_UNKNOWN_ERROR	"API_3007"	packages/api/src/errors/codes.ts:39
GEOCODING_INVALID_COORDINATES	"GEOCODING_4002"	packages/api/src/errors/codes.ts:43
GEOCODING_NOT_FOUND	"GEOCODING_4001"	packages/api/src/errors/codes.ts:42
GEOCODING_REQUEST_FAILED	"GEOCODING_4003"	packages/api/src/errors/codes.ts:44
NAVIGATION_NOT_STARTED	"NAVIGATION_6001"	packages/api/src/errors/codes.ts:53
NAVIGATION_OFF_ROUTE	"NAVIGATION_6002"	packages/api/src/errors/codes.ts:54
NAVIGATION_REQUEST_FAILED	"NAVIGATION_6003"	packages/api/src/errors/codes.ts:55
NETWORK_FAILED	"NETWORK_2001"	packages/api/src/errors/codes.ts:27
NETWORK_OFFLINE	"NETWORK_2003"	packages/api/src/errors/codes.ts:29
NETWORK_REQUEST_FAILED	"NETWORK_2004"	packages/api/src/errors/codes.ts:30
NETWORK_TIMEOUT	"NETWORK_2002"	packages/api/src/errors/codes.ts:28
PLATFORM_GEOLOCATION_DENIED	"PLATFORM_7001"	packages/api/src/errors/codes.ts:58
PLATFORM_GEOLOCATION_TIMEOUT	"PLATFORM_7003"	packages/api/src/errors/codes.ts:60
PLATFORM_GEOLOCATION_UNAVAILABLE	"PLATFORM_7002"	packages/api/src/errors/codes.ts:59
PLATFORM_NOT_INITIALIZED	"PLATFORM_7004"	packages/api/src/errors/codes.ts:61
ROUTING_INVALID_POLYLINE	"ROUTING_5004"	packages/api/src/errors/codes.ts:50
ROUTING_INVALID_WAYPOINTS	"ROUTING_5002"	packages/api/src/errors/codes.ts:48
ROUTING_NO_ROUTE	"ROUTING_5001"	packages/api/src/errors/codes.ts:47
ROUTING_REQUEST_FAILED	"ROUTING_5003"	packages/api/src/errors/codes.ts:49
VALIDATION_INVALID_FORMAT	"VALIDATION_1002"	packages/api/src/errors/codes.ts:22
VALIDATION_INVALID_TYPE	"VALIDATION_1004"	packages/api/src/errors/codes.ts:24
VALIDATION_OUT_OF_RANGE	"VALIDATION_1003"	packages/api/src/errors/codes.ts:23
VALIDATION_REQUIRED_FIELD	"VALIDATION_1001"	packages/api/src/errors/codes.ts:21

---

ErrorDomain

Error domain/feature area where an error occurred.

Enumeration Members

Enumeration Member	Value	Defined in
API	"api"	packages/api/src/errors/codes.ts:7
GEOCODING	"geocoding"	packages/api/src/errors/codes.ts:8
NAVIGATION	"navigation"	packages/api/src/errors/codes.ts:10
NETWORK	"network"	packages/api/src/errors/codes.ts:6
PLATFORM	"platform"	packages/api/src/errors/codes.ts:12
ROUTING	"routing"	packages/api/src/errors/codes.ts:9
TRACKING	"tracking"	packages/api/src/errors/codes.ts:11
VALIDATION	"validation"	packages/api/src/errors/codes.ts:5

Classes

ApiError

Base error class for API-related errors.

Extends

• GebetaError

Extended by

• BadRequestError
• UnauthorizedError
• ForbiddenError
• NotFoundError
• RateLimitError
• ServerError

Constructors

new ApiError()

new ApiError(
   message, 
   statusCode, 
   code, 
   requestId?, 
   context?): ApiError

Parameters

Parameter	Type
message	string
statusCode	number
code	ErrorCode
requestId?	string
context?	Record<string, unknown>

Returns

ApiError

Overrides

GebetaError.constructor

Defined in

packages/api/src/errors/api.ts:11

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	GebetaError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	GebetaError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	GebetaError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	GebetaError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	GebetaError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	GebetaError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	GebetaError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	GebetaError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
statusCode	readonly	number	-	-	packages/api/src/errors/api.ts:9
timestamp	readonly	number	-	GebetaError.timestamp	packages/api/src/errors/base.ts:13
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.	GebetaError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

GebetaError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

GebetaError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

fromResponse()

static fromResponse(response, statusCode): ApiError

Parameters

Parameter	Type
response	ApiErrorResponse
statusCode	number

Returns

ApiError

Defined in

packages/api/src/errors/api.ts:30

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

GebetaError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

BadRequestError

Error thrown for 400 Bad Request responses.

Extends

• ApiError

Constructors

new BadRequestError()

new BadRequestError(
   message, 
   requestId?, 
   context?): BadRequestError

Parameters

Parameter	Type
message	string
requestId?	string
context?	Record<string, unknown>

Returns

BadRequestError

Overrides

ApiError.constructor

Defined in

packages/api/src/errors/api.ts:45

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	ApiError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	ApiError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	ApiError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	ApiError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	ApiError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	ApiError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	ApiError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	ApiError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
statusCode	readonly	number	-	ApiError.statusCode	packages/api/src/errors/api.ts:9
timestamp	readonly	number	-	ApiError.timestamp	packages/api/src/errors/base.ts:13
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.	ApiError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

ApiError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

ApiError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

fromResponse()

static fromResponse(response, statusCode): ApiError

Parameters

Parameter	Type
response	ApiErrorResponse
statusCode	number

Returns

ApiError

Inherited from

ApiError.fromResponse

Defined in

packages/api/src/errors/api.ts:30

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

ApiError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

BusinessLogicError

Base error class for business logic errors.

Extends

• GebetaError

Extended by

• GeocodingError
• RoutingError
• NavigationError
• TrackingError

Constructors

new BusinessLogicError()

new BusinessLogicError(
   code, 
   message, 
   domain, 
   context?): BusinessLogicError

Parameters

Parameter	Type
code	ErrorCode
message	string
domain	ErrorDomain
context?	Record<string, unknown>

Returns

BusinessLogicError

Overrides

GebetaError.constructor

Defined in

packages/api/src/errors/business.ts:8

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	GebetaError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	GebetaError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	GebetaError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	GebetaError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	GebetaError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	GebetaError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	GebetaError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	GebetaError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
timestamp	readonly	number	-	GebetaError.timestamp	packages/api/src/errors/base.ts:13
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.	GebetaError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

GebetaError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

GebetaError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

GebetaError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

ForbiddenError

Error thrown for 403 Forbidden responses.

Extends

• ApiError

Constructors

new ForbiddenError()

new ForbiddenError(message, requestId?): ForbiddenError

Parameters

Parameter	Type
message	string
requestId?	string

Returns

ForbiddenError

Overrides

ApiError.constructor

Defined in

packages/api/src/errors/api.ts:65

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	ApiError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	ApiError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	ApiError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	ApiError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	ApiError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	ApiError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	ApiError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	ApiError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
statusCode	readonly	number	-	ApiError.statusCode	packages/api/src/errors/api.ts:9
timestamp	readonly	number	-	ApiError.timestamp	packages/api/src/errors/base.ts:13
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.	ApiError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

ApiError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

ApiError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

fromResponse()

static fromResponse(response, statusCode): ApiError

Parameters

Parameter	Type
response	ApiErrorResponse
statusCode	number

Returns

ApiError

Inherited from

ApiError.fromResponse

Defined in

packages/api/src/errors/api.ts:30

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

ApiError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

GebetaError

Base error class for all Gebeta SDK errors. Provides consistent error structure across all SDKs.

Extends

• Error

Extended by

• ValidationError
• NetworkError
• ApiError
• BusinessLogicError
• PlatformError

Constructors

new GebetaError()

new GebetaError(details): GebetaError

Parameters

Parameter	Type
details	GebetaErrorDetails

Returns

GebetaError

Overrides

Error.constructor

Defined in

packages/api/src/errors/base.ts:16

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	-	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	-	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	-	packages/api/src/errors/base.ts:10
message	public	string	-	Error.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	Error.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	-	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	-	packages/api/src/errors/base.ts:14
stack?	public	string	-	Error.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
timestamp	readonly	number	-	-	packages/api/src/errors/base.ts:13
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	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

Defined in

node_modules/@types/node/globals.d.ts:52

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

GeocodingError

Error thrown for geocoding-related failures.

Extends

• BusinessLogicError

Constructors

new GeocodingError()

new GeocodingError(
   code, 
   message, 
   context?): GeocodingError

Parameters

Parameter	Type
code	ErrorCode
message	string
context?	Record<string, unknown>

Returns

GeocodingError

Overrides

BusinessLogicError.constructor

Defined in

packages/api/src/errors/business.ts:29

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	BusinessLogicError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	BusinessLogicError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	BusinessLogicError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	BusinessLogicError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	BusinessLogicError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	BusinessLogicError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	BusinessLogicError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	BusinessLogicError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
timestamp	readonly	number	-	BusinessLogicError.timestamp	packages/api/src/errors/base.ts:13
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.	BusinessLogicError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

BusinessLogicError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

BusinessLogicError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

BusinessLogicError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

GeolocationDeniedError

Error thrown when geolocation access is denied.

Extends

• PlatformError

Constructors

new GeolocationDeniedError()

new GeolocationDeniedError(originalError?): GeolocationDeniedError

Parameters

Parameter	Type
originalError?	Error

Returns

GeolocationDeniedError

Overrides

PlatformError.constructor

Defined in

packages/api/src/errors/platform.ts:30

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	PlatformError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	PlatformError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	PlatformError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	PlatformError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	PlatformError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	PlatformError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	PlatformError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	PlatformError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
timestamp	readonly	number	-	PlatformError.timestamp	packages/api/src/errors/base.ts:13
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.	PlatformError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

PlatformError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

PlatformError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

PlatformError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

GeolocationTimeoutError

Error thrown when geolocation request times out.

Extends

• PlatformError

Constructors

new GeolocationTimeoutError()

new GeolocationTimeoutError(timeoutMs?, originalError?): GeolocationTimeoutError

Parameters

Parameter	Type
timeoutMs?	number
originalError?	Error

Returns

GeolocationTimeoutError

Overrides

PlatformError.constructor

Defined in

packages/api/src/errors/platform.ts:60

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	PlatformError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	PlatformError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	PlatformError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	PlatformError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	PlatformError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	PlatformError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	PlatformError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	PlatformError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
timestamp	readonly	number	-	PlatformError.timestamp	packages/api/src/errors/base.ts:13
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.	PlatformError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

PlatformError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

PlatformError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

PlatformError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

GeolocationUnavailableError

Error thrown when geolocation is unavailable.

Extends

• PlatformError

Constructors

new GeolocationUnavailableError()

new GeolocationUnavailableError(originalError?): GeolocationUnavailableError

Parameters

Parameter	Type
originalError?	Error

Returns

GeolocationUnavailableError

Overrides

PlatformError.constructor

Defined in

packages/api/src/errors/platform.ts:45

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	PlatformError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	PlatformError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	PlatformError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	PlatformError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	PlatformError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	PlatformError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	PlatformError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	PlatformError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
timestamp	readonly	number	-	PlatformError.timestamp	packages/api/src/errors/base.ts:13
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.	PlatformError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

PlatformError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

PlatformError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

PlatformError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

NavigationError

Error thrown for navigation-related failures.

Extends

• BusinessLogicError

Constructors

new NavigationError()

new NavigationError(
   code, 
   message, 
   context?): NavigationError

Parameters

Parameter	Type
code	ErrorCode
message	string
context?	Record<string, unknown>

Returns

NavigationError

Overrides

BusinessLogicError.constructor

Defined in

packages/api/src/errors/business.ts:49

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	BusinessLogicError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	BusinessLogicError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	BusinessLogicError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	BusinessLogicError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	BusinessLogicError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	BusinessLogicError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	BusinessLogicError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	BusinessLogicError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
timestamp	readonly	number	-	BusinessLogicError.timestamp	packages/api/src/errors/base.ts:13
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.	BusinessLogicError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

BusinessLogicError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

BusinessLogicError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

BusinessLogicError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

NetworkError

Error thrown when network operations fail.

Extends

• GebetaError

Extended by

• NetworkTimeoutError
• NetworkOfflineError

Constructors

new NetworkError()

new NetworkError(
   message, 
   code, 
   originalError?, 
   context?): NetworkError

Parameters

Parameter	Type
message	string
code	ErrorCode
originalError?	Error
context?	Record<string, unknown>

Returns

NetworkError

Overrides

GebetaError.constructor

Defined in

packages/api/src/errors/network.ts:8

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	GebetaError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	GebetaError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	GebetaError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	GebetaError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	GebetaError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	GebetaError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	GebetaError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	GebetaError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
timestamp	readonly	number	-	GebetaError.timestamp	packages/api/src/errors/base.ts:13
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.	GebetaError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

GebetaError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

GebetaError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

GebetaError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

NetworkOfflineError

Error thrown when the device is offline.

Extends

• NetworkError

Constructors

new NetworkOfflineError()

new NetworkOfflineError(originalError?): NetworkOfflineError

Parameters

Parameter	Type
originalError?	Error

Returns

NetworkOfflineError

Overrides

NetworkError.constructor

Defined in

packages/api/src/errors/network.ts:45

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	NetworkError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	NetworkError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	NetworkError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	NetworkError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	NetworkError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	NetworkError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	NetworkError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	NetworkError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
timestamp	readonly	number	-	NetworkError.timestamp	packages/api/src/errors/base.ts:13
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.	NetworkError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

NetworkError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

NetworkError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

NetworkError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

NetworkTimeoutError

Error thrown when a network request times out.

Extends

• NetworkError

Constructors

new NetworkTimeoutError()

new NetworkTimeoutError(timeoutMs?, originalError?): NetworkTimeoutError

Parameters

Parameter	Type
timeoutMs?	number
originalError?	Error

Returns

NetworkTimeoutError

Overrides

NetworkError.constructor

Defined in

packages/api/src/errors/network.ts:30

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	NetworkError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	NetworkError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	NetworkError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	NetworkError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	NetworkError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	NetworkError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	NetworkError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	NetworkError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
timestamp	readonly	number	-	NetworkError.timestamp	packages/api/src/errors/base.ts:13
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.	NetworkError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

NetworkError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

NetworkError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

NetworkError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

NotFoundError

Error thrown for 404 Not Found responses.

Extends

• ApiError

Constructors

new NotFoundError()

new NotFoundError(message, requestId?): NotFoundError

Parameters

Parameter	Type
message	string
requestId?	string

Returns

NotFoundError

Overrides

ApiError.constructor

Defined in

packages/api/src/errors/api.ts:75

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	ApiError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	ApiError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	ApiError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	ApiError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	ApiError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	ApiError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	ApiError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	ApiError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
statusCode	readonly	number	-	ApiError.statusCode	packages/api/src/errors/api.ts:9
timestamp	readonly	number	-	ApiError.timestamp	packages/api/src/errors/base.ts:13
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.	ApiError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

ApiError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

ApiError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

fromResponse()

static fromResponse(response, statusCode): ApiError

Parameters

Parameter	Type
response	ApiErrorResponse
statusCode	number

Returns

ApiError

Inherited from

ApiError.fromResponse

Defined in

packages/api/src/errors/api.ts:30

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

ApiError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

PlatformError

Error thrown for platform-specific failures (e.g., geolocation API).

Extends

• GebetaError

Extended by

• GeolocationDeniedError
• GeolocationUnavailableError
• GeolocationTimeoutError

Constructors

new PlatformError()

new PlatformError(
   code, 
   message, 
   context?, 
   originalError?): PlatformError

Parameters

Parameter	Type
code	ErrorCode
message	string
context?	Record<string, unknown>
originalError?	Error

Returns

PlatformError

Overrides

GebetaError.constructor

Defined in

packages/api/src/errors/platform.ts:8

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	GebetaError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	GebetaError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	GebetaError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	GebetaError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	GebetaError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	GebetaError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	GebetaError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	GebetaError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
timestamp	readonly	number	-	GebetaError.timestamp	packages/api/src/errors/base.ts:13
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.	GebetaError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

GebetaError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

GebetaError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

GebetaError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

RateLimitError

Error thrown for 429 Rate Limit responses.

Extends

• ApiError

Constructors

new RateLimitError()

new RateLimitError(
   message, 
   requestId?, 
   retryAfter?): RateLimitError

Parameters

Parameter	Type
message	string
requestId?	string
retryAfter?	number

Returns

RateLimitError

Overrides

ApiError.constructor

Defined in

packages/api/src/errors/api.ts:85

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	ApiError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	ApiError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	ApiError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	ApiError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	ApiError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	ApiError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	ApiError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	ApiError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
statusCode	readonly	number	-	ApiError.statusCode	packages/api/src/errors/api.ts:9
timestamp	readonly	number	-	ApiError.timestamp	packages/api/src/errors/base.ts:13
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.	ApiError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

ApiError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

ApiError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

fromResponse()

static fromResponse(response, statusCode): ApiError

Parameters

Parameter	Type
response	ApiErrorResponse
statusCode	number

Returns

ApiError

Inherited from

ApiError.fromResponse

Defined in

packages/api/src/errors/api.ts:30

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

ApiError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

RoutingError

Error thrown for routing-related failures.

Extends

• BusinessLogicError

Constructors

new RoutingError()

new RoutingError(
   code, 
   message, 
   context?): RoutingError

Parameters

Parameter	Type
code	ErrorCode
message	string
context?	Record<string, unknown>

Returns

RoutingError

Overrides

BusinessLogicError.constructor

Defined in

packages/api/src/errors/business.ts:39

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	BusinessLogicError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	BusinessLogicError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	BusinessLogicError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	BusinessLogicError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	BusinessLogicError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	BusinessLogicError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	BusinessLogicError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	BusinessLogicError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
timestamp	readonly	number	-	BusinessLogicError.timestamp	packages/api/src/errors/base.ts:13
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.	BusinessLogicError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

BusinessLogicError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

BusinessLogicError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

BusinessLogicError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

ServerError

Error thrown for 5xx Server Error responses.

Extends

• ApiError

Constructors

new ServerError()

new ServerError(
   message, 
   statusCode, 
   requestId?): ServerError

Parameters

Parameter	Type
message	string
statusCode	number
requestId?	string

Returns

ServerError

Overrides

ApiError.constructor

Defined in

packages/api/src/errors/api.ts:101

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	ApiError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	ApiError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	ApiError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	ApiError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	ApiError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	ApiError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	ApiError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	ApiError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
statusCode	readonly	number	-	ApiError.statusCode	packages/api/src/errors/api.ts:9
timestamp	readonly	number	-	ApiError.timestamp	packages/api/src/errors/base.ts:13
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.	ApiError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

ApiError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

ApiError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

fromResponse()

static fromResponse(response, statusCode): ApiError

Parameters

Parameter	Type
response	ApiErrorResponse
statusCode	number

Returns

ApiError

Inherited from

ApiError.fromResponse

Defined in

packages/api/src/errors/api.ts:30

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

ApiError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

TrackingError

Error thrown for tracking-related failures.

Extends

• BusinessLogicError

Constructors

new TrackingError()

new TrackingError(
   code, 
   message, 
   context?): TrackingError

Parameters

Parameter	Type
code	ErrorCode
message	string
context?	Record<string, unknown>

Returns

TrackingError

Overrides

BusinessLogicError.constructor

Defined in

packages/api/src/errors/business.ts:59

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	BusinessLogicError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	BusinessLogicError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	BusinessLogicError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	BusinessLogicError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	BusinessLogicError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	BusinessLogicError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	BusinessLogicError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	BusinessLogicError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
timestamp	readonly	number	-	BusinessLogicError.timestamp	packages/api/src/errors/base.ts:13
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.	BusinessLogicError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

BusinessLogicError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

BusinessLogicError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

BusinessLogicError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

UnauthorizedError

Error thrown for 401 Unauthorized responses.

Extends

• ApiError

Constructors

new UnauthorizedError()

new UnauthorizedError(message, requestId?): UnauthorizedError

Parameters

Parameter	Type
message	string
requestId?	string

Returns

UnauthorizedError

Overrides

ApiError.constructor

Defined in

packages/api/src/errors/api.ts:55

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	ApiError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	ApiError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	ApiError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	ApiError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	ApiError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	ApiError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	ApiError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	ApiError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
statusCode	readonly	number	-	ApiError.statusCode	packages/api/src/errors/api.ts:9
timestamp	readonly	number	-	ApiError.timestamp	packages/api/src/errors/base.ts:13
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.	ApiError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

ApiError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

ApiError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

fromResponse()

static fromResponse(response, statusCode): ApiError

Parameters

Parameter	Type
response	ApiErrorResponse
statusCode	number

Returns

ApiError

Inherited from

ApiError.fromResponse

Defined in

packages/api/src/errors/api.ts:30

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

ApiError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

---

ValidationError

Error thrown when input validation fails.

Extends

• GebetaError

Constructors

new ValidationError()

new ValidationError(
   message, 
   field?, 
   context?): ValidationError

Parameters

Parameter	Type
message	string
field?	string
context?	Record<string, unknown>

Returns

ValidationError

Overrides

GebetaError.constructor

Defined in

packages/api/src/errors/validation.ts:8

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
code	readonly	ErrorCode	-	GebetaError.code	packages/api/src/errors/base.ts:9
context?	readonly	Record<string, unknown>	-	GebetaError.context	packages/api/src/errors/base.ts:11
domain?	readonly	ErrorDomain	-	GebetaError.domain	packages/api/src/errors/base.ts:10
message	public	string	-	GebetaError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	GebetaError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
originalError?	readonly	Error	-	GebetaError.originalError	packages/api/src/errors/base.ts:12
requestId?	readonly	string	-	GebetaError.requestId	packages/api/src/errors/base.ts:14
stack?	public	string	-	GebetaError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
timestamp	readonly	number	-	GebetaError.timestamp	packages/api/src/errors/base.ts:13
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.	GebetaError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68

Methods

toJSON()

toJSON(): GebetaErrorDetails

Get error details as a plain object.

Returns

GebetaErrorDetails

Inherited from

GebetaError.toJSON

Defined in

packages/api/src/errors/base.ts:36

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

GebetaError.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:52

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

GebetaError.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:56

Interfaces

ApiErrorResponse

API error response structure from backend.

Properties

Property	Type	Defined in
error	object	packages/api/src/errors/types.ts:38
error.code?	string	packages/api/src/errors/types.ts:39
error.details?	Record<string, unknown>	packages/api/src/errors/types.ts:41
error.message	string	packages/api/src/errors/types.ts:40
error.requestId?	string	packages/api/src/errors/types.ts:42

---

GebetaErrorDetails

Base error details structure for all Gebeta errors.

Properties

Property	Type	Description	Defined in
code	ErrorCode	Error code for programmatic error handling	packages/api/src/errors/types.ts:8
context?	Record<string, unknown>	Additional context data for debugging and error handling. Examples: - Field names that failed validation - Retry information (e.g., { retryAfter: 60 }) - Request parameters that caused the error - Any other relevant debugging information	packages/api/src/errors/types.ts:21
domain?	ErrorDomain	Domain/feature area where the error occurred	packages/api/src/errors/types.ts:12
message	string	Human-readable error message	packages/api/src/errors/types.ts:10
originalError?	Error	Original error that was wrapped (if applicable)	packages/api/src/errors/types.ts:23
requestId?	string	Request ID from the API response (for API errors). Used to correlate errors with server-side logs for debugging. Typically returned in response headers (x-request-id) or error response body.	packages/api/src/errors/types.ts:31
timestamp	number	Timestamp when the error occurred	packages/api/src/errors/types.ts:25

Functions

createApiError()

function createApiError(
   statusCode, 
   response, 
   requestId?): ApiError

Creates an API error from an HTTP response. Uses getErrorCodeForStatusCode (from api.ts) as the single source of truth for status code → error code mapping, then instantiates the appropriate error class.

Parameters

Parameter	Type
statusCode	number
response	string | ApiErrorResponse
requestId?	string

Returns

ApiError

Defined in

packages/api/src/errors/factories.ts:64

---

createGeocodingError()

function createGeocodingError(
   code, 
   message, 
   context?): GeocodingError

Creates a geocoding error given a code, message and a context.

Parameters

Parameter	Type
code	ErrorCode
message	string
context?	Record<string, unknown>

Returns

GeocodingError

Defined in

packages/api/src/errors/factories.ts:116

---

createNavigationError()

function createNavigationError(
   code, 
   message, 
   context?): NavigationError

Creates a navigation error given a code, message and a context.

Parameters

Parameter	Type
code	ErrorCode
message	string
context?	Record<string, unknown>

Returns

NavigationError

Defined in

packages/api/src/errors/factories.ts:138

---

createNetworkError()

function createNetworkError(originalError, context?): NetworkError

Creates a network error from a fetch failure given an original error and a context.

Parameters

Parameter	Type
originalError	Error
context?	Record<string, unknown>

Returns

NetworkError

Defined in

packages/api/src/errors/factories.ts:30

---

createNetworkOfflineError()

function createNetworkOfflineError(originalError?): NetworkOfflineError

Creates a network offline error.

Parameters

Parameter	Type
originalError?	Error

Returns

NetworkOfflineError

Defined in

packages/api/src/errors/factories.ts:55

---

createNetworkTimeoutError()

function createNetworkTimeoutError(originalError?, timeoutMs?): NetworkTimeoutError

Creates a network timeout error given a timeout in milliseconds and an original error.

Parameters

Parameter	Type
originalError?	Error
timeoutMs?	number

Returns

NetworkTimeoutError

Defined in

packages/api/src/errors/factories.ts:45

---

createRoutingError()

function createRoutingError(
   code, 
   message, 
   context?): RoutingError

Creates a routing error given a code, message and a context.

Parameters

Parameter	Type
code	ErrorCode
message	string
context?	Record<string, unknown>

Returns

RoutingError

Defined in

packages/api/src/errors/factories.ts:127

---

createTrackingError()

function createTrackingError(
   code, 
   message, 
   context?): TrackingError

Creates a tracking error given a code, message and a context.

Parameters

Parameter	Type
code	ErrorCode
message	string
context?	Record<string, unknown>

Returns

TrackingError

Defined in

packages/api/src/errors/factories.ts:149

---

createValidationError()

function createValidationError(field, reason?): ValidationError

Creates a validation error for a required field given a field name and a reason.

Parameters

Parameter	Type
field	string
reason?	string

Returns

ValidationError

Defined in

packages/api/src/errors/factories.ts:20

---

extractRequestId()

function extractRequestId(response): Promise<string | undefined>

Extracts request ID from a Response object (from headers or body).

Parameters

Parameter	Type
response	Response

Returns

Promise<string | undefined>

Defined in

packages/api/src/errors/utils.ts:79

---

formatErrorForLogging()

function formatErrorForLogging(error): string

Formats an error for logging purposes.

Parameters

Parameter	Type
error	GebetaError

Returns

string

Defined in

packages/api/src/errors/utils.ts:35

---

getErrorCode()

function getErrorCode(error): ErrorCode | null

Gets the error code from an error, or null if not a GebetaError.

Parameters

Parameter	Type
error	unknown

Returns

ErrorCode | null

Defined in

packages/api/src/errors/utils.ts:15

---

getErrorDomain()

function getErrorDomain(error): ErrorDomain | null

Gets the error domain from an error, or null if not a GebetaError.

Parameters

Parameter	Type
error	unknown

Returns

ErrorDomain | null

Defined in

packages/api/src/errors/utils.ts:25

---

isGebetaError()

function isGebetaError(error): error is GebetaError

Type guard to check if an error is a GebetaError.

Parameters

Parameter	Type
error	unknown

Returns

error is GebetaError

Defined in

packages/api/src/errors/utils.ts:8

---

parseApiErrorResponse()

function parseApiErrorResponse(response): Promise<ApiErrorResponse>

Parses an API error response from a Response object.

Parameters

Parameter	Type
response	Response

Returns

Promise<ApiErrorResponse>

Defined in

packages/api/src/errors/utils.ts:56

Namespaces

Namespace	Description
API	-
Clustering	-
Common	-
Components	-
Events	-
Fencing	-
Geocoding	-
Map	-
Navigation	-
Overlay	-
Platform	-
Routing	-
Tracking	-