isCanisterError

Call Signature

isCanisterError<E>(error): error is CanisterError<E>

Defined in: errors/index.ts:152

Type guard to check if an error is a CanisterError. Preserves the generic type E from the input when used in type narrowing.

Type Parameters

E

E

Parameters

error

CallError | CanisterError<E>

Returns

error is CanisterError<E>

Example

// err is typed as CanisterError<TransferError> | CallError
if (isCanisterError(err)) {
  // err.err is typed as TransferError (preserved!)
  console.log(err.err)
}

Call Signature

isCanisterError(error): error is CanisterError<unknown>

Defined in: errors/index.ts:155

Type guard to check if an error is a CanisterError. Preserves the generic type E from the input when used in type narrowing.

Parameters

error

unknown

Returns

error is CanisterError<unknown>

Example

// err is typed as CanisterError<TransferError> | CallError
if (isCanisterError(err)) {
  // err.err is typed as TransferError (preserved!)
  console.log(err.err)
}