AppLockError

Thrown when the app lock is refused: another run holds it (held), the lock to resume is not the one held (not-held), the state moved since it was last refreshed (state-moved), or the state holds journal files of a run that was never archived (unfinished), named in stateFileNames.

@group

Errors/Transaction

Hierarchy

• TransactionError
  • AppLockError

Index

Constructors

• constructor

Properties

• holder
• newestCommitId
• reason
• refreshedCommitId
• stateFileNames

Constructors

constructor

• AppLockError(message: string, details: { holder?: { commitId?: string; context?: string; lockId: string; takenAt?: number }; newestCommitId?: string; reason: held | not-held | state-moved | unfinished; refreshedCommitId?: string; stateFileNames?: string[] }): AppLockError

• Overrides TransactionError.constructor

  Parameters

  • message: string

    The error message.

  • details: { holder?: { commitId?: string; context?: string; lockId: string; takenAt?: number }; newestCommitId?: string; reason: held | not-held | state-moved | unfinished; refreshedCommitId?: string; stateFileNames?: string[] }

    Why the lock was refused, and what the state provider knows about it.

  • optionalholder: { commitId?: string; context?: string; lockId: string; takenAt?: number }

  • optionalnewestCommitId: string

  • reason: held | not-held | state-moved | unfinished

  • optionalrefreshedCommitId: string

  • optionalstateFileNames: string[]

  Returns AppLockError

Properties

optionalreadonlyholder

holder?: { commitId?: string; context?: string; lockId: string; takenAt?: number }

Type declaration

• optionalcommitId?: string

• optionalcontext?: string

• lockId: string

• optionaltakenAt?: number

optionalreadonlynewestCommitId

newestCommitId?: string

readonlyreason

reason: held | not-held | state-moved | unfinished

optionalreadonlyrefreshedCommitId

refreshedCommitId?: string

optionalreadonlystateFileNames

stateFileNames?: string[]