Class TokenNotAllowedError

Error thrown when a token is not configured on the lock.

Hierarchy

LockError
- TokenNotAllowedError

Index

Constructors

Properties

code lockId message stack? token prepareStackTrace? stackTraceLimit

Accessors

Methods

captureStackTrace

Constructors

constructor

new TokenNotAllowedError(token: TokenId, lockId: LockId): TokenNotAllowedError
Parameters
- token: TokenId
  
  The token not allowed by the lock configuration.
- lockId: LockId
  
  The lock whose token list was checked.
Returns TokenNotAllowedError
Overrides LockError.constructor
- Defined in packages/sdk/src/plt/Lock.ts:118

Properties

`Readonly` code

code: TOKEN_NOT_ALLOWED = LockErrorCode.TOKEN_NOT_ALLOWED

`Readonly` lockId

lockId: LockId

The lock whose token list was checked.

message

message: string

`Optional` stack

stack?: string

`Readonly` token

token: TokenId

The token not allowed by the lock configuration.

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Type declaration

- (err: Error, stackTraces: CallSite[]): any
- Optional override for formatting stack traces
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

`Static` stackTraceLimit

stackTraceLimit: number

Accessors

name

get name(): string
Returns string
Inherited from LockError.name
- Defined in packages/sdk/src/plt/Lock.ts:57

Methods

`Static` captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from LockError.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:21

Generated using TypeDoc