ITwinError Namespace

Function

Defined in

• core/common/src/ITwinError.ts Line 40

ITwinError Interface

An interface used to describe an error for a developer/application. The message is not intended to be displayed to an end user. This error interface should be extended when needing to throw errors with extra properties defined on them. See InUseLocksError for an example. When extending ITwinError, one should typically add a type guard function and a function to throw the error either to a namespace for their error or as standalone functions. See throwInUseLocksError and isInUseLocksError for examples of how to throw and check that an error is of type InUseLocksError.

• Example of catching a ITwinError:

  try {
  await briefcaseDb.locks.acquireLocks({ exclusive: elementId });
  } catch (err) {
  if (InUseLocksError.isInUseLocksError(err)) {
    const inUseLocks = err.inUseLocks;
    for (const inUseLock of inUseLocks) {
      const _briefcaseIds = inUseLock.briefcaseIds;
      const _state = inUseLock.state;
      const _objectId = inUseLock.objectId;
      // Create a user friendly error message
    }
  } else {
    throw err;
  }
  

Properties

Defined in

• core/common/src/ITwinError.ts Line 40