XmtpError

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:384

A failure from the XMTP SDK. Its subclass names the failure variant. details.code keeps the Rust cause code.

Extends

Error

Constructors

Constructor

new XmtpError(details): XmtpError

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:386

Parameters

details

ErrorDetails

Returns

XmtpError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

details

readonly details: ErrorDetails

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:385

message

message: string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

Error.message

name

name: string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

Error.name

stack?

optional stack?: string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.stack

Attachment

readonly static Attachment: typeof XmtpErrorAttachment

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:428

AuthRequired

readonly static AuthRequired: typeof XmtpErrorAuthRequired

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:402

BackendMismatch

readonly static BackendMismatch: typeof XmtpErrorBackendMismatch

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:400

CallbackFailed

readonly static CallbackFailed: typeof XmtpErrorCallbackFailed

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:406

Cancelled

readonly static Cancelled: typeof XmtpErrorCancelled

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:446

ChainNotAccepted

readonly static ChainNotAccepted: typeof XmtpErrorChainNotAccepted

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:403

ChannelNotConfigured

readonly static ChannelNotConfigured: typeof XmtpErrorChannelNotConfigured

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:413

ClientClosed

readonly static ClientClosed: typeof XmtpErrorClientClosed

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:387

ClientVersionTooOld

readonly static ClientVersionTooOld: typeof XmtpErrorClientVersionTooOld

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:401

CodecDecodeFailed

readonly static CodecDecodeFailed: typeof XmtpErrorCodecDecodeFailed

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:438

CodecEncodeFailed

readonly static CodecEncodeFailed: typeof XmtpErrorCodecEncodeFailed

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:436

CodecNotFound

readonly static CodecNotFound: typeof XmtpErrorCodecNotFound

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:437

ConfigurationInvalid

readonly static ConfigurationInvalid: typeof XmtpErrorConfigurationInvalid

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:399

ConfigurationUnavailable

readonly static ConfigurationUnavailable: typeof XmtpErrorConfigurationUnavailable

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:398

ConsumerOwned

readonly static ConsumerOwned: typeof XmtpErrorConsumerOwned

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:424

Credential

readonly static Credential: typeof XmtpErrorCredential

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:397

CredentialCallbackFailed

readonly static CredentialCallbackFailed: typeof XmtpErrorCredentialCallbackFailed

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:405

CredentialExhausted

readonly static CredentialExhausted: typeof XmtpErrorCredentialExhausted

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:407

CredentialMissing

readonly static CredentialMissing: typeof XmtpErrorCredentialMissing

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:408

CredentialRejected

readonly static CredentialRejected: typeof XmtpErrorCredentialRejected

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:404

DuplicateField

readonly static DuplicateField: typeof XmtpErrorDuplicateField

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:432

ForeignCursor

readonly static ForeignCursor: typeof XmtpErrorForeignCursor

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:426

HandleLimitReached

readonly static HandleLimitReached: typeof XmtpErrorHandleLimitReached

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:445

HandleNotAllowed

readonly static HandleNotAllowed: typeof XmtpErrorHandleNotAllowed

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:443

HandleTaken

readonly static HandleTaken: typeof XmtpErrorHandleTaken

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:442

HandleTooSoon

readonly static HandleTooSoon: typeof XmtpErrorHandleTooSoon

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:444

IdentityMismatch

readonly static IdentityMismatch: typeof XmtpErrorIdentityMismatch

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:429

IdentityNotFound

readonly static IdentityNotFound: typeof XmtpErrorIdentityNotFound

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:390

InvalidArgument

readonly static InvalidArgument: typeof XmtpErrorInvalidArgument

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:410

InvalidCursor

readonly static InvalidCursor: typeof XmtpErrorInvalidCursor

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:425

InvalidInput

readonly static InvalidInput: typeof XmtpErrorInvalidInput

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:388

Lagged

readonly static Lagged: typeof XmtpErrorLagged

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:423

MalformedEnvelope

readonly static MalformedEnvelope: typeof XmtpErrorMalformedEnvelope

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:439

MigrationFailed

readonly static MigrationFailed: typeof XmtpErrorMigrationFailed

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:393

MigrationOutput

readonly static MigrationOutput: typeof XmtpErrorMigrationOutput

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:395

MigrationRecordRead

readonly static MigrationRecordRead: typeof XmtpErrorMigrationRecordRead

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:394

MigrationUnsupportedSchema

readonly static MigrationUnsupportedSchema: typeof XmtpErrorMigrationUnsupportedSchema

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:392

NotificationApi

readonly static NotificationApi: typeof XmtpErrorNotificationApi

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:418

NotificationGroup

readonly static NotificationGroup: typeof XmtpErrorNotificationGroup

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:420

NotificationNotFound

readonly static NotificationNotFound: typeof XmtpErrorNotificationNotFound

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:417

NotificationStorage

readonly static NotificationStorage: typeof XmtpErrorNotificationStorage

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:419

NotUserField

readonly static NotUserField: typeof XmtpErrorNotUserField

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:431

OutOfRange

readonly static OutOfRange: typeof XmtpErrorOutOfRange

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:411

PermissionDenied

readonly static PermissionDenied: typeof XmtpErrorPermissionDenied

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:409

PublishedButUnconfirmed

readonly static PublishedButUnconfirmed: typeof XmtpErrorPublishedButUnconfirmed

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:440

RecoveryExhausted

readonly static RecoveryExhausted: typeof XmtpErrorRecoveryExhausted

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:421

RequestTimeout

readonly static RequestTimeout: typeof XmtpErrorRequestTimeout

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:416

ResourceExhausted

readonly static ResourceExhausted: typeof XmtpErrorResourceExhausted

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:415

Signer

readonly static Signer: typeof XmtpErrorSigner

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:396

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Storage

readonly static Storage: typeof XmtpErrorStorage

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:422

StorageBusy

readonly static StorageBusy: typeof XmtpErrorStorageBusy

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:391

StorageLocation

readonly static StorageLocation: typeof XmtpErrorStorageLocation

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:427

StorageLocationRequired

readonly static StorageLocationRequired: typeof XmtpErrorStorageLocationRequired

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:389

TaskRunnerDisabled

readonly static TaskRunnerDisabled: typeof XmtpErrorTaskRunnerDisabled

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:414

TypeChanged

readonly static TypeChanged: typeof XmtpErrorTypeChanged

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:435

TypeMismatch

readonly static TypeMismatch: typeof XmtpErrorTypeMismatch

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:434

Unimplemented

readonly static Unimplemented: typeof XmtpErrorUnimplemented

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:412

Unknown

readonly static Unknown: typeof XmtpErrorUnknown

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:447

UnknownField

readonly static UnknownField: typeof XmtpErrorUnknownField

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:430

UnsupportedType

readonly static UnsupportedType: typeof XmtpErrorUnsupportedType

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:433

UserLimitExceeded

readonly static UserLimitExceeded: typeof XmtpErrorUserLimitExceeded

Defined in: sdks/browser/dist/typescript-pure/public-values.gen.d.ts:441

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.esnext.error.d.ts:21

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

Error.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace