index¶

statusCode¶

readonly statusCode: number

Defined in¶

details?¶

readonly optional details: ErrorDetails

Defined in¶

timestamp¶

readonly timestamp: Date

Defined in¶

Methods¶

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¶

• targetObject: object

• constructorOpt?: Function

Returns¶

void

Inherited from¶

Error.captureStackTrace

Defined in¶

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

prepareStackTrace()¶

static prepareStackTrace(err, stackTraces): any

Parameters¶

• 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:55

toJSON()¶

toJSON(): object

Returns¶

object

error¶

error: object

error.code¶

code: ErrorCode

error.message¶

message: string

error.details¶

details: undefined | ErrorDetails

error.timestamp¶

timestamp: Date

Defined in¶

AuthenticationError¶

Authentication error (401)

Extends¶

CyberEcoError

Extended by¶

Constructors¶

new AuthenticationError()¶

new AuthenticationError(message, code, details?): AuthenticationError

Parameters¶

• message: string = 'Authentication failed'

• code: ErrorCode = ErrorCode.UNAUTHORIZED

• details?: ErrorDetails

Properties¶

stackTraceLimit¶

static stackTraceLimit: 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.

Inherited from¶

Defined in¶

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

cause?¶

optional cause: unknown

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es2022.error.d.ts:24

name¶

name: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1076

message¶

message: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1077

stack?¶

optional stack: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1078

code¶

readonly code: ErrorCode

Inherited from¶

Defined in¶

statusCode¶

readonly statusCode: number

Inherited from¶

Defined in¶

details?¶

readonly optional details: ErrorDetails

Inherited from¶

Defined in¶

timestamp¶

readonly timestamp: Date

Inherited from¶

Defined in¶

Methods¶

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¶

• targetObject: object

• constructorOpt?: Function

Returns¶

void

Inherited from¶

Defined in¶

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

prepareStackTrace()¶

static prepareStackTrace(err, stackTraces): any

Parameters¶

• err: Error

• stackTraces: CallSite[]

Returns¶

any

See¶

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

Inherited from¶

Defined in¶

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

toJSON()¶

toJSON(): object

Returns¶

object

error¶

error: object

error.code¶

code: ErrorCode

error.message¶

message: string

error.details¶

details: undefined | ErrorDetails

error.timestamp¶

timestamp: Date

Inherited from¶

Defined in¶

AuthorizationError¶

Authorization error (403)

Extends¶

CyberEcoError

Extended by¶

Constructors¶

new AuthorizationError()¶

new AuthorizationError(message, code, details?): AuthorizationError

Parameters¶

• message: string = 'Access denied'

• code: ErrorCode = ErrorCode.PERMISSION_DENIED

• details?: ErrorDetails

Returns¶

AuthorizationError

Overrides¶

packages/auth/src/utils/errors.ts:109

Defined in¶

Properties¶

stackTraceLimit¶

static stackTraceLimit: 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.

Inherited from¶

Defined in¶

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

cause?¶

optional cause: unknown

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es2022.error.d.ts:24

name¶

name: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1076

message¶

message: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1077

stack?¶

optional stack: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1078

code¶

readonly code: ErrorCode

Inherited from¶

Defined in¶

statusCode¶

readonly statusCode: number

Inherited from¶

Defined in¶

details?¶

readonly optional details: ErrorDetails

Inherited from¶

Defined in¶

timestamp¶

readonly timestamp: Date

Inherited from¶

Defined in¶

Methods¶

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¶

• targetObject: object

• constructorOpt?: Function

Returns¶

void

Inherited from¶

Defined in¶

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

prepareStackTrace()¶

static prepareStackTrace(err, stackTraces): any

Parameters¶

• err: Error

• stackTraces: CallSite[]

Returns¶

any

See¶

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

Inherited from¶

Defined in¶

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

toJSON()¶

toJSON(): object

Returns¶

object

error¶

error: object

error.code¶

code: ErrorCode

error.message¶

message: string

error.details¶

details: undefined | ErrorDetails

error.timestamp¶

timestamp: Date

Inherited from¶

Defined in¶

ValidationError¶

Validation error (400)

Extends¶

CyberEcoError

Constructors¶

new ValidationError()¶

new ValidationError(message, details?): ValidationError

Parameters¶

• message: string = 'Validation failed'

• details?: ErrorDetails

Returns¶

ValidationError

Overrides¶

packages/auth/src/utils/errors.ts:118

Defined in¶

Properties¶

stackTraceLimit¶

static stackTraceLimit: 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.

Inherited from¶

Defined in¶

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

cause?¶

optional cause: unknown

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es2022.error.d.ts:24

name¶

name: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1076

message¶

message: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1077

stack?¶

optional stack: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1078

code¶

readonly code: ErrorCode

Inherited from¶

Defined in¶

statusCode¶

readonly statusCode: number

Inherited from¶

Defined in¶

details?¶

readonly optional details: ErrorDetails

Inherited from¶

Defined in¶

timestamp¶

readonly timestamp: Date

Inherited from¶

Defined in¶

Methods¶

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¶

• targetObject: object

• constructorOpt?: Function

Returns¶

void

Inherited from¶

Defined in¶

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

prepareStackTrace()¶

static prepareStackTrace(err, stackTraces): any

Parameters¶

• err: Error

• stackTraces: CallSite[]

Returns¶

any

See¶

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

Inherited from¶

Defined in¶

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

toJSON()¶

toJSON(): object

Returns¶

object

error¶

error: object

error.code¶

code: ErrorCode

error.message¶

message: string

error.details¶

details: undefined | ErrorDetails

error.timestamp¶

timestamp: Date

Inherited from¶

Defined in¶

NotFoundError¶

Not found error (404)

Extends¶

CyberEcoError

Constructors¶

new NotFoundError()¶

new NotFoundError(message, details?): NotFoundError

Parameters¶

• message: string = 'Resource not found'

• details?: ErrorDetails

Returns¶

NotFoundError

Overrides¶

packages/auth/src/utils/errors.ts:127

Defined in¶

Properties¶

stackTraceLimit¶

static stackTraceLimit: 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.

Inherited from¶

Defined in¶

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

cause?¶

optional cause: unknown

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es2022.error.d.ts:24

name¶

name: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1076

message¶

message: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1077

stack?¶

optional stack: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1078

code¶

readonly code: ErrorCode

Inherited from¶

Defined in¶

statusCode¶

readonly statusCode: number

Inherited from¶

Defined in¶

details?¶

readonly optional details: ErrorDetails

Inherited from¶

Defined in¶

timestamp¶

readonly timestamp: Date

Inherited from¶

Defined in¶

Methods¶

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¶

• targetObject: object

• constructorOpt?: Function

Returns¶

void

Inherited from¶

Defined in¶

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

prepareStackTrace()¶

static prepareStackTrace(err, stackTraces): any

Parameters¶

• err: Error

• stackTraces: CallSite[]

Returns¶

any

See¶

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

Inherited from¶

Defined in¶

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

toJSON()¶

toJSON(): object

Returns¶

object

error¶

error: object

error.code¶

code: ErrorCode

error.message¶

message: string

error.details¶

details: undefined | ErrorDetails

error.timestamp¶

timestamp: Date

Inherited from¶

Defined in¶

ConflictError¶

Conflict error (409)

Extends¶

CyberEcoError

Constructors¶

new ConflictError()¶

new ConflictError(message, details?): ConflictError

Parameters¶

• message: string = 'Resource conflict'

• details?: ErrorDetails

Returns¶

ConflictError

Overrides¶

packages/auth/src/utils/errors.ts:136

Defined in¶

Properties¶

stackTraceLimit¶

static stackTraceLimit: 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.

Inherited from¶

Defined in¶

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

cause?¶

optional cause: unknown

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es2022.error.d.ts:24

name¶

name: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1076

message¶

message: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1077

stack?¶

optional stack: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1078

code¶

readonly code: ErrorCode

Inherited from¶

Defined in¶

statusCode¶

readonly statusCode: number

Inherited from¶

Defined in¶

details?¶

readonly optional details: ErrorDetails

Inherited from¶

Defined in¶

timestamp¶

readonly timestamp: Date

Inherited from¶

Defined in¶

Methods¶

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¶

• targetObject: object

• constructorOpt?: Function

Returns¶

void

Inherited from¶

Defined in¶

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

prepareStackTrace()¶

static prepareStackTrace(err, stackTraces): any

Parameters¶

• err: Error

• stackTraces: CallSite[]

Returns¶

any

See¶

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

Inherited from¶

Defined in¶

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

toJSON()¶

toJSON(): object

Returns¶

object

error¶

error: object

error.code¶

code: ErrorCode

error.message¶

message: string

error.details¶

details: undefined | ErrorDetails

error.timestamp¶

timestamp: Date

Inherited from¶

Defined in¶

RateLimitError¶

Rate limit error (429)

Extends¶

CyberEcoError

Constructors¶

new RateLimitError()¶

new RateLimitError(message, retryAfter?): RateLimitError

Parameters¶

• message: string = 'Too many requests'

• retryAfter?: number

Returns¶

RateLimitError

Overrides¶

packages/auth/src/utils/errors.ts:147

Defined in¶

Properties¶

stackTraceLimit¶

static stackTraceLimit: 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.

Inherited from¶

Defined in¶

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

cause?¶

optional cause: unknown

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es2022.error.d.ts:24

name¶

name: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1076

message¶

message: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1077

stack?¶

optional stack: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1078

code¶

readonly code: ErrorCode

Inherited from¶

Defined in¶

statusCode¶

readonly statusCode: number

Inherited from¶

Defined in¶

details?¶

readonly optional details: ErrorDetails

Inherited from¶

Defined in¶

timestamp¶

readonly timestamp: Date

Inherited from¶

Defined in¶

packages/auth/src/utils/errors.ts:145

retryAfter?¶

readonly optional retryAfter: number

Defined in¶

Methods¶

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¶

• targetObject: object

• constructorOpt?: Function

Returns¶

void

Inherited from¶

Defined in¶

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

prepareStackTrace()¶

static prepareStackTrace(err, stackTraces): any

Parameters¶

• err: Error

• stackTraces: CallSite[]

Returns¶

any

See¶

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

Inherited from¶

Defined in¶

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

toJSON()¶

toJSON(): object

Returns¶

object

error¶

error: object

error.code¶

code: ErrorCode

error.message¶

message: string

error.details¶

details: undefined | ErrorDetails

error.timestamp¶

timestamp: Date

retryAfter¶

retryAfter: undefined | number

Overrides¶

packages/auth/src/utils/errors.ts:152

Defined in¶

InternalError¶

Internal server error (500)

Extends¶

CyberEcoError

Constructors¶

new InternalError()¶

new InternalError(message, details?): InternalError

Parameters¶

• message: string = 'Internal server error'

• details?: ErrorDetails

Returns¶

InternalError

Overrides¶

packages/auth/src/utils/errors.ts:164

Defined in¶

Properties¶

stackTraceLimit¶

static stackTraceLimit: 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.

Inherited from¶

Defined in¶

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

cause?¶

optional cause: unknown

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es2022.error.d.ts:24

name¶

name: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1076

message¶

message: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1077

stack?¶

optional stack: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1078

code¶

readonly code: ErrorCode

Inherited from¶

Defined in¶

statusCode¶

readonly statusCode: number

Inherited from¶

Defined in¶

details?¶

readonly optional details: ErrorDetails

Inherited from¶

Defined in¶

timestamp¶

readonly timestamp: Date

Inherited from¶

Defined in¶

Methods¶

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¶

• targetObject: object

• constructorOpt?: Function

Returns¶

void

Inherited from¶

Defined in¶

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

prepareStackTrace()¶

static prepareStackTrace(err, stackTraces): any

Parameters¶

• err: Error

• stackTraces: CallSite[]

Returns¶

any

See¶

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

Inherited from¶

Defined in¶

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

toJSON()¶

toJSON(): object

Returns¶

object

error¶

error: object

error.code¶

code: ErrorCode

error.message¶

message: string

error.details¶

details: undefined | ErrorDetails

error.timestamp¶

timestamp: Date

Inherited from¶

Defined in¶

ServiceUnavailableError

ServiceUnavailableError¶

Service unavailable error (503)

Extends¶

CyberEcoError

Constructors¶

new ServiceUnavailableError()¶

new ServiceUnavailableError(message, retryAfter?): ServiceUnavailableError

Parameters¶

• message: string = 'Service temporarily unavailable'

• retryAfter?: number

Returns¶

Overrides¶

packages/auth/src/utils/errors.ts:175

Defined in¶

Properties¶

stackTraceLimit¶

static stackTraceLimit: 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.

Inherited from¶

Defined in¶

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

cause?¶

optional cause: unknown

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es2022.error.d.ts:24

name¶

name: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1076

message¶

message: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1077

stack?¶

optional stack: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1078

code¶

readonly code: ErrorCode

Inherited from¶

Defined in¶

statusCode¶

readonly statusCode: number

Inherited from¶

Defined in¶

details?¶

readonly optional details: ErrorDetails

Inherited from¶

Defined in¶

timestamp¶

readonly timestamp: Date

Inherited from¶

Defined in¶

packages/auth/src/utils/errors.ts:173

retryAfter?¶

readonly optional retryAfter: number

Defined in¶

Methods¶

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¶

• targetObject: object

• constructorOpt?: Function

Returns¶

void

Inherited from¶

Defined in¶

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

prepareStackTrace()¶

static prepareStackTrace(err, stackTraces): any

Parameters¶

• err: Error

• stackTraces: CallSite[]

Returns¶

any

See¶

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

Inherited from¶

Defined in¶

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

toJSON()¶

toJSON(): object

Returns¶

object

error¶

error: object

error.code¶

code: ErrorCode

error.message¶

message: string

error.details¶

details: undefined | ErrorDetails

error.timestamp¶

timestamp: Date

Inherited from¶

Defined in¶

AuthenticationError.constructor

TokenExpiredError¶

Token-specific errors

Extends¶

AuthenticationError

Constructors¶

new TokenExpiredError()¶

new TokenExpiredError(message): TokenExpiredError

Parameters¶

• message: string = 'Token has expired'

Returns¶

TokenExpiredError

Overrides¶

Defined in¶

packages/auth/src/utils/errors.ts:185

Properties¶

stackTraceLimit¶

static stackTraceLimit: 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.

Inherited from¶

AuthenticationError.stackTraceLimit

Defined in¶

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

cause?¶

optional cause: unknown

Inherited from¶

AuthenticationError.cause

Defined in¶

node_modules/typescript/lib/lib.es2022.error.d.ts:24

name¶

name: string

Inherited from¶

AuthenticationError.name

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1076

message¶

message: string

Inherited from¶

AuthenticationError.message

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1077

stack?¶

optional stack: string

Inherited from¶

AuthenticationError.stack

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1078

code¶

readonly code: ErrorCode

Inherited from¶

AuthenticationError.code

Defined in¶

AuthenticationError.statusCode

statusCode¶

readonly statusCode: number

Inherited from¶

Defined in¶

AuthenticationError.details

details?¶

readonly optional details: ErrorDetails

Inherited from¶

Defined in¶

AuthenticationError.timestamp

timestamp¶

readonly timestamp: Date

Inherited from¶

Defined in¶

AuthenticationError.captureStackTrace

Methods¶

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¶

• targetObject: object

• constructorOpt?: Function

Returns¶

void

Inherited from¶

Defined in¶

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

prepareStackTrace()¶

static prepareStackTrace(err, stackTraces): any

Parameters¶

• err: Error

• stackTraces: CallSite[]

Returns¶

any

See¶

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

Inherited from¶

AuthenticationError.prepareStackTrace

Defined in¶

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

toJSON()¶

toJSON(): object

Returns¶

object

error¶

error: object

error.code¶

code: ErrorCode

error.message¶

message: string

error.details¶

details: undefined | ErrorDetails

error.timestamp¶

timestamp: Date

Inherited from¶

AuthenticationError.toJSON

Defined in¶

AuthenticationError.constructor

InvalidTokenError¶

Authentication error (401)

Extends¶

AuthenticationError

Constructors¶

new InvalidTokenError()¶

new InvalidTokenError(message): InvalidTokenError

Parameters¶

• message: string = 'Invalid token'

Returns¶

InvalidTokenError

Overrides¶

Defined in¶

packages/auth/src/utils/errors.ts:191

Properties¶

stackTraceLimit¶

static stackTraceLimit: 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.

Inherited from¶

AuthenticationError.stackTraceLimit

Defined in¶

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

cause?¶

optional cause: unknown

Inherited from¶

AuthenticationError.cause

Defined in¶

node_modules/typescript/lib/lib.es2022.error.d.ts:24

name¶

name: string

Inherited from¶

AuthenticationError.name

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1076

message¶

message: string

Inherited from¶

AuthenticationError.message

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1077

stack?¶

optional stack: string

Inherited from¶

AuthenticationError.stack

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1078

code¶

readonly code: ErrorCode

Inherited from¶

AuthenticationError.code

Defined in¶

AuthenticationError.statusCode

statusCode¶

readonly statusCode: number

Inherited from¶

Defined in¶

AuthenticationError.details

details?¶

readonly optional details: ErrorDetails

Inherited from¶

Defined in¶

AuthenticationError.timestamp

timestamp¶

readonly timestamp: Date

Inherited from¶

Defined in¶

AuthenticationError.captureStackTrace

Methods¶

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¶

• targetObject: object

• constructorOpt?: Function

Returns¶

void

Inherited from¶

Defined in¶

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

prepareStackTrace()¶

static prepareStackTrace(err, stackTraces): any

Parameters¶

• err: Error

• stackTraces: CallSite[]

Returns¶

any

See¶

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

Inherited from¶

AuthenticationError.prepareStackTrace

Defined in¶

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

toJSON()¶

toJSON(): object

Returns¶

object

error¶

error: object

error.code¶

code: ErrorCode

error.message¶

message: string

error.details¶

details: undefined | ErrorDetails

error.timestamp¶

timestamp: Date

Inherited from¶

AuthenticationError.toJSON

Defined in¶

TwoFactorRequiredError¶

2FA-specific errors

Extends¶

CyberEcoError

Constructors¶

new TwoFactorRequiredError()¶

new TwoFactorRequiredError(message): TwoFactorRequiredError

Parameters¶

• message: string = '2FA verification required'

Returns¶

TwoFactorRequiredError

Overrides¶

packages/auth/src/utils/errors.ts:200

Defined in¶

Properties¶

stackTraceLimit¶

static stackTraceLimit: 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.

Inherited from¶

Defined in¶

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

cause?¶

optional cause: unknown

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es2022.error.d.ts:24

name¶

name: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1076

message¶

message: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1077

stack?¶

optional stack: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1078

code¶

readonly code: ErrorCode

Inherited from¶

Defined in¶

statusCode¶

readonly statusCode: number

Inherited from¶

Defined in¶

details?¶

readonly optional details: ErrorDetails

Inherited from¶

Defined in¶

timestamp¶

readonly timestamp: Date

Inherited from¶

Defined in¶

Methods¶

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¶

• targetObject: object

• constructorOpt?: Function

Returns¶

void

Inherited from¶

Defined in¶

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

prepareStackTrace()¶

static prepareStackTrace(err, stackTraces): any

Parameters¶

• err: Error

• stackTraces: CallSite[]

Returns¶

any

See¶

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

Inherited from¶

Defined in¶

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

toJSON()¶

toJSON(): object

Returns¶

object

error¶

error: object

error.code¶

code: ErrorCode

error.message¶

message: string

error.details¶

details: undefined | ErrorDetails

error.timestamp¶

timestamp: Date

Inherited from¶

Defined in¶

InvalidTwoFactorCodeError

InvalidTwoFactorCodeError¶

Authentication error (401)

Extends¶

AuthenticationError

Constructors¶

new InvalidTwoFactorCodeError()¶

new InvalidTwoFactorCodeError(message): InvalidTwoFactorCodeError

Parameters¶

• message: string = 'Invalid 2FA code'

Returns¶

Overrides¶

AuthenticationError.constructor

Defined in¶

packages/auth/src/utils/errors.ts:206

Properties¶

stackTraceLimit¶

static stackTraceLimit: 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.

Inherited from¶

AuthenticationError.stackTraceLimit

Defined in¶

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

cause?¶

optional cause: unknown

Inherited from¶

AuthenticationError.cause

Defined in¶

node_modules/typescript/lib/lib.es2022.error.d.ts:24

name¶

name: string

Inherited from¶

AuthenticationError.name

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1076

message¶

message: string

Inherited from¶

AuthenticationError.message

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1077

stack?¶

optional stack: string

Inherited from¶

AuthenticationError.stack

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1078

code¶

readonly code: ErrorCode

Inherited from¶

AuthenticationError.code

Defined in¶

AuthenticationError.statusCode

statusCode¶

readonly statusCode: number

Inherited from¶

Defined in¶

AuthenticationError.details

details?¶

readonly optional details: ErrorDetails

Inherited from¶

Defined in¶

AuthenticationError.timestamp

timestamp¶

readonly timestamp: Date

Inherited from¶

Defined in¶

AuthenticationError.captureStackTrace

Methods¶

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¶

• targetObject: object

• constructorOpt?: Function

Returns¶

void

Inherited from¶

Defined in¶

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

prepareStackTrace()¶

static prepareStackTrace(err, stackTraces): any

Parameters¶

• err: Error

• stackTraces: CallSite[]

Returns¶

any

See¶

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

Inherited from¶

AuthenticationError.prepareStackTrace

Defined in¶

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

toJSON()¶

toJSON(): object

Returns¶

object

error¶

error: object

error.code¶

code: ErrorCode

error.message¶

message: string

error.details¶

details: undefined | ErrorDetails

error.timestamp¶

timestamp: Date

Inherited from¶

AuthenticationError.toJSON

Defined in¶

AuthorizationError.constructor

ConsentRequiredError¶

Privacy/GDPR-specific errors

Extends¶

AuthorizationError

Constructors¶

new ConsentRequiredError()¶

new ConsentRequiredError(message, details?): ConsentRequiredError

Parameters¶

• message: string = 'User consent required'

• details?: ErrorDetails

Returns¶

ConsentRequiredError

Overrides¶

Defined in¶

packages/auth/src/utils/errors.ts:215

Properties¶

stackTraceLimit¶

static stackTraceLimit: 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.

Inherited from¶

AuthorizationError.stackTraceLimit

Defined in¶

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

cause?¶

optional cause: unknown

Inherited from¶

AuthorizationError.cause

Defined in¶

node_modules/typescript/lib/lib.es2022.error.d.ts:24

name¶

name: string

Inherited from¶

AuthorizationError.name

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1076

message¶

message: string

Inherited from¶

AuthorizationError.message

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1077

stack?¶

optional stack: string

Inherited from¶

AuthorizationError.stack

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1078

code¶

readonly code: ErrorCode

Inherited from¶

AuthorizationError.code

Defined in¶

AuthorizationError.statusCode

statusCode¶

readonly statusCode: number

Inherited from¶

Defined in¶

AuthorizationError.details

details?¶

readonly optional details: ErrorDetails

Inherited from¶

Defined in¶

AuthorizationError.timestamp

timestamp¶

readonly timestamp: Date

Inherited from¶

Defined in¶

AuthorizationError.captureStackTrace

Methods¶

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¶

• targetObject: object

• constructorOpt?: Function

Returns¶

void

Inherited from¶

Defined in¶

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

prepareStackTrace()¶

static prepareStackTrace(err, stackTraces): any

Parameters¶

• err: Error

• stackTraces: CallSite[]

Returns¶

any

See¶

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

Inherited from¶

AuthorizationError.prepareStackTrace

Defined in¶

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

toJSON()¶

toJSON(): object

Returns¶

object

error¶

error: object

error.code¶

code: ErrorCode

error.message¶

message: string

error.details¶

details: undefined | ErrorDetails

error.timestamp¶

timestamp: Date

Inherited from¶

AuthorizationError.toJSON

Defined in¶

AuthorizationError.constructor

DataAccessDeniedError¶

Authorization error (403)

Extends¶

AuthorizationError

Constructors¶

new DataAccessDeniedError()¶

new DataAccessDeniedError(message, details?): DataAccessDeniedError

Parameters¶

• message: string = 'Data access denied due to privacy settings'

• details?: ErrorDetails

Returns¶

DataAccessDeniedError

Overrides¶

Defined in¶

packages/auth/src/utils/errors.ts:221

Properties¶

stackTraceLimit¶

static stackTraceLimit: 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.

Inherited from¶

AuthorizationError.stackTraceLimit

Defined in¶

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

cause?¶

optional cause: unknown

Inherited from¶

AuthorizationError.cause

Defined in¶

node_modules/typescript/lib/lib.es2022.error.d.ts:24

name¶

name: string

Inherited from¶

AuthorizationError.name

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1076

message¶

message: string

Inherited from¶

AuthorizationError.message

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1077

stack?¶

optional stack: string

Inherited from¶

AuthorizationError.stack

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1078

code¶

readonly code: ErrorCode

Inherited from¶

AuthorizationError.code

Defined in¶

AuthorizationError.statusCode

statusCode¶

readonly statusCode: number

Inherited from¶

Defined in¶

AuthorizationError.details

details?¶

readonly optional details: ErrorDetails

Inherited from¶

Defined in¶

AuthorizationError.timestamp

timestamp¶

readonly timestamp: Date

Inherited from¶

Defined in¶

AuthorizationError.captureStackTrace

Methods¶

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¶

• targetObject: object

• constructorOpt?: Function

Returns¶

void

Inherited from¶

Defined in¶

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

prepareStackTrace()¶

static prepareStackTrace(err, stackTraces): any

Parameters¶

• err: Error

• stackTraces: CallSite[]

Returns¶

any

See¶

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

Inherited from¶

AuthorizationError.prepareStackTrace

Defined in¶

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

toJSON()¶

toJSON(): object

Returns¶

object

error¶

error: object

error.code¶

code: ErrorCode

error.message¶

message: string

error.details¶

details: undefined | ErrorDetails

error.timestamp¶

timestamp: Date

Inherited from¶

AuthorizationError.toJSON

Defined in¶

ExportLimitExceededError

ExportLimitExceededError¶

Export-specific errors

Extends¶

CyberEcoError

Constructors¶

new ExportLimitExceededError()¶

new ExportLimitExceededError(message, details?): ExportLimitExceededError

Parameters¶

• message: string = 'Export limit exceeded'

• details?: ErrorDetails

Returns¶

Overrides¶

packages/auth/src/utils/errors.ts:230

Defined in¶

Properties¶

stackTraceLimit¶

static stackTraceLimit: 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.

Inherited from¶

Defined in¶

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

cause?¶

optional cause: unknown

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es2022.error.d.ts:24

name¶

name: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1076

message¶

message: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1077

stack?¶

optional stack: string

Inherited from¶

Defined in¶

node_modules/typescript/lib/lib.es5.d.ts:1078

code¶

readonly code: ErrorCode

Inherited from¶

Defined in¶

statusCode¶

readonly statusCode: number

Inherited from¶

Defined in¶

details?¶

readonly optional details: ErrorDetails

Inherited from¶

Defined in¶

timestamp¶

readonly timestamp: Date

Inherited from¶

Defined in¶

Methods¶

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¶

• targetObject: object

• constructorOpt?: Function

Returns¶

void

Inherited from¶

Defined in¶

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

prepareStackTrace()¶

static prepareStackTrace(err, stackTraces): any

Parameters¶

• err: Error

• stackTraces: CallSite[]

Returns¶

any

See¶

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

Inherited from¶

Defined in¶

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

toJSON()¶

toJSON(): object

Returns¶

object

error¶

error: object

error.code¶

code: ErrorCode

error.message¶

message: string

error.details¶

details: undefined | ErrorDetails

error.timestamp¶

timestamp: Date

Inherited from¶

Defined in¶