Skip to content

@gala-chain/api ∙ API

API > ForbiddenError

Class: ForbiddenError

Contents

Extends

Constructors

new ForbiddenError(args)

new ForbiddenError(...args): ForbiddenError

Parameters

▪ ...args: unknown[]

Inherited from

ChainError.constructor

Source

chain-api/src/utils/error.ts:17

Properties

code

readonly code: ErrorCode

Status code, a value from ErrorCode enum. It is directly mapped to HTTP, status, it is a constant value to be used by clients integrating with the chain.

Inherited from

ChainError.code

Source

chain-api/src/utils/error.ts:45

key

readonly key: Uppercase\<string>

An upper case string to be used as a key do diagnose where the error comes from and help with regular development. It should not be used by client integrating with the chain since we don't guarantee it won't change. It is generated from original error class name.

Inherited from

ChainError.key

Source

chain-api/src/utils/error.ts:53

message

message: string

Inherited from

ChainError.message

Source

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

name

name: string

Inherited from

ChainError.name

Source

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

payload

readonly payload?: Record\<string, unknown>

Additional information to be used by

Inherited from

ChainError.payload

Source

chain-api/src/utils/error.ts:58

stack

stack?: string

Inherited from

ChainError.stack

Source

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

Methods

andExec()

andExec(fn): ChainError

Allows to execute function getting as a parameter the current error.

Parameters

▪ fn: (e) => void

Returns

Inherited from

ChainError.andExec

Example

throw CommonChainError.objectNotFound(objectId).andExec((e) => {
  logger.error(e.message);
});

Source

chain-api/src/utils/error.ts:114

logError()

logError(logger): ChainError

Parameters

▪ logger: object

▪ logger.error

Inherited from

ChainError.logError

Source

chain-api/src/utils/error.ts:119

logWarn()

logWarn(logger): ChainError

Parameters

▪ logger: object

▪ logger.warn

Inherited from

ChainError.logWarn

Source

chain-api/src/utils/error.ts:124

map()

map(key, newError): ChainError

Maps ChainError to another chain error by error code if key param matches current error code or current diagnostic key. Otherwise, returns original error.

Useful in rethrowing an error or mapping an error to another one in catch clauses or catch methods in promises.

Parameters

▪ key: ErrorCode | ClassConstructor\<ChainError>

error code or error class to match

▪ newError: ChainError | (e) => ChainError

new error or a function to create the new error

Inherited from

ChainError.map

Source

chain-api/src/utils/error.ts:148

matches()

matches(key): boolean

Parameters

▪ key: ErrorCode | ClassConstructor\<ChainError>

Inherited from

ChainError.matches

Source

chain-api/src/utils/error.ts:129