Class LockExpiredError

Error thrown when an operation is attempted against an expired lock.

Hierarchy

LockError
- LockExpiredError

Index

Constructors

Properties

code lockId message stack? prepareStackTrace? stackTraceLimit

Accessors

Methods

captureStackTrace

Constructors

constructor

new LockExpiredError(lockId: LockId): LockExpiredError
Parameters
- lockId: LockId
  
  The expired lock id.
Returns LockExpiredError
Overrides LockError.constructor
- Defined in packages/sdk/src/plt/Lock.ts:87

Properties

`Readonly` code

code: LOCK_EXPIRED = LockErrorCode.LOCK_EXPIRED

`Readonly` lockId

lockId: LockId

The expired lock id.

message

message: string

`Optional` stack

stack?: string

`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