Mobile Document Scanner API Reference / ScannerStateError

Class: ScannerStateError

Defined in: src/faults.ts:64

The error of a method that starts work, when the document scanner cannot start it. The methods are preload(), scan(), and reset(). As with the errors of the DOM for a call in the wrong state, it is a DOMException with the name InvalidStateError.

Extends

• DOMException

Constructors

Constructor

new ScannerStateError(reason): ScannerStateError

Defined in: src/faults.ts:73

Make the error for reason, with the message of that reason.

Parameters

reason

ScannerStateReason

The reason that the method could not start.

Returns

ScannerStateError

Overrides

DOMException.constructor

Properties

ABORT_ERR

readonly ABORT_ERR: 20

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11354

Inherited from

DOMException.ABORT_ERR

---

cause?

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

DOMException.cause

---

code

readonly code: number

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11322

The code read-only property of the DOMException interface returns one of the legacy error code constants, or 0 if none match.

Deprecated

MDN Reference

Inherited from

DOMException.code

---

DATA_CLONE_ERR

readonly DATA_CLONE_ERR: 25

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11359

Inherited from

DOMException.DATA_CLONE_ERR

---

DOMSTRING_SIZE_ERR

readonly DOMSTRING_SIZE_ERR: 2

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11336

Inherited from

DOMException.DOMSTRING_SIZE_ERR

---

HIERARCHY_REQUEST_ERR

readonly HIERARCHY_REQUEST_ERR: 3

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11337

Inherited from

DOMException.HIERARCHY_REQUEST_ERR

---

INDEX_SIZE_ERR

readonly INDEX_SIZE_ERR: 1

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11335

Inherited from

DOMException.INDEX_SIZE_ERR

---

INUSE_ATTRIBUTE_ERR

readonly INUSE_ATTRIBUTE_ERR: 10

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11344

Inherited from

DOMException.INUSE_ATTRIBUTE_ERR

---

INVALID_ACCESS_ERR

readonly INVALID_ACCESS_ERR: 15

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11349

Inherited from

DOMException.INVALID_ACCESS_ERR

---

INVALID_CHARACTER_ERR

readonly INVALID_CHARACTER_ERR: 5

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11339

Inherited from

DOMException.INVALID_CHARACTER_ERR

---

INVALID_MODIFICATION_ERR

readonly INVALID_MODIFICATION_ERR: 13

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11347

Inherited from

DOMException.INVALID_MODIFICATION_ERR

---

INVALID_NODE_TYPE_ERR

readonly INVALID_NODE_TYPE_ERR: 24

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11358

Inherited from

DOMException.INVALID_NODE_TYPE_ERR

---

INVALID_STATE_ERR

readonly INVALID_STATE_ERR: 11

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11345

Inherited from

DOMException.INVALID_STATE_ERR

---

message

readonly message: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11328

The message read-only property of the DOMException interface returns a string representing a message or description associated with the given error name.

MDN Reference

Inherited from

DOMException.message

---

name

readonly name: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11334

The name read-only property of the DOMException interface returns a string that contains one of the strings associated with an error name.

MDN Reference

Inherited from

DOMException.name

---

NAMESPACE_ERR

readonly NAMESPACE_ERR: 14

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11348

Inherited from

DOMException.NAMESPACE_ERR

---

NETWORK_ERR

readonly NETWORK_ERR: 19

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11353

Inherited from

DOMException.NETWORK_ERR

---

NO_DATA_ALLOWED_ERR

readonly NO_DATA_ALLOWED_ERR: 6

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11340

Inherited from

DOMException.NO_DATA_ALLOWED_ERR

---

NO_MODIFICATION_ALLOWED_ERR

readonly NO_MODIFICATION_ALLOWED_ERR: 7

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11341

Inherited from

DOMException.NO_MODIFICATION_ALLOWED_ERR

---

NOT_FOUND_ERR

readonly NOT_FOUND_ERR: 8

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11342

Inherited from

DOMException.NOT_FOUND_ERR

---

NOT_SUPPORTED_ERR

readonly NOT_SUPPORTED_ERR: 9

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11343

Inherited from

DOMException.NOT_SUPPORTED_ERR

---

QUOTA_EXCEEDED_ERR

readonly QUOTA_EXCEEDED_ERR: 22

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11356

Inherited from

DOMException.QUOTA_EXCEEDED_ERR

---

reason

readonly reason: ScannerStateReason

Defined in: src/faults.ts:66

The reason that the method could not start.

---

SECURITY_ERR

readonly SECURITY_ERR: 18

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11352

Inherited from

DOMException.SECURITY_ERR

---

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

DOMException.stack

---

SYNTAX_ERR

readonly SYNTAX_ERR: 12

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11346

Inherited from

DOMException.SYNTAX_ERR

---

TIMEOUT_ERR

readonly TIMEOUT_ERR: 23

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11357

Inherited from

DOMException.TIMEOUT_ERR

---

TYPE_MISMATCH_ERR

readonly TYPE_MISMATCH_ERR: 17

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11351

Inherited from

DOMException.TYPE_MISMATCH_ERR

---

URL_MISMATCH_ERR

readonly URL_MISMATCH_ERR: 21

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11355

Inherited from

DOMException.URL_MISMATCH_ERR

---

VALIDATION_ERR

readonly VALIDATION_ERR: 16

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11350

Inherited from

DOMException.VALIDATION_ERR

---

WRONG_DOCUMENT_ERR

readonly WRONG_DOCUMENT_ERR: 4

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11338

Inherited from

DOMException.WRONG_DOCUMENT_ERR

---

ABORT_ERR

readonly static ABORT_ERR: 20

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11384

Inherited from

DOMException.ABORT_ERR

---

DATA_CLONE_ERR

readonly static DATA_CLONE_ERR: 25

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11389

Inherited from

DOMException.DATA_CLONE_ERR

---

DOMSTRING_SIZE_ERR

readonly static DOMSTRING_SIZE_ERR: 2

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11366

Inherited from

DOMException.DOMSTRING_SIZE_ERR

---

HIERARCHY_REQUEST_ERR

readonly static HIERARCHY_REQUEST_ERR: 3

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11367

Inherited from

DOMException.HIERARCHY_REQUEST_ERR

---

INDEX_SIZE_ERR

readonly static INDEX_SIZE_ERR: 1

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11365

Inherited from

DOMException.INDEX_SIZE_ERR

---

INUSE_ATTRIBUTE_ERR

readonly static INUSE_ATTRIBUTE_ERR: 10

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11374

Inherited from

DOMException.INUSE_ATTRIBUTE_ERR

---

INVALID_ACCESS_ERR

readonly static INVALID_ACCESS_ERR: 15

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11379

Inherited from

DOMException.INVALID_ACCESS_ERR

---

INVALID_CHARACTER_ERR

readonly static INVALID_CHARACTER_ERR: 5

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11369

Inherited from

DOMException.INVALID_CHARACTER_ERR

---

INVALID_MODIFICATION_ERR

readonly static INVALID_MODIFICATION_ERR: 13

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11377

Inherited from

DOMException.INVALID_MODIFICATION_ERR

---

INVALID_NODE_TYPE_ERR

readonly static INVALID_NODE_TYPE_ERR: 24

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11388

Inherited from

DOMException.INVALID_NODE_TYPE_ERR

---

INVALID_STATE_ERR

readonly static INVALID_STATE_ERR: 11

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11375

Inherited from

DOMException.INVALID_STATE_ERR

---

NAMESPACE_ERR

readonly static NAMESPACE_ERR: 14

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11378

Inherited from

DOMException.NAMESPACE_ERR

---

NETWORK_ERR

readonly static NETWORK_ERR: 19

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11383

Inherited from

DOMException.NETWORK_ERR

---

NO_DATA_ALLOWED_ERR

readonly static NO_DATA_ALLOWED_ERR: 6

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11370

Inherited from

DOMException.NO_DATA_ALLOWED_ERR

---

NO_MODIFICATION_ALLOWED_ERR

readonly static NO_MODIFICATION_ALLOWED_ERR: 7

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11371

Inherited from

DOMException.NO_MODIFICATION_ALLOWED_ERR

---

NOT_FOUND_ERR

readonly static NOT_FOUND_ERR: 8

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11372

Inherited from

DOMException.NOT_FOUND_ERR

---

NOT_SUPPORTED_ERR

readonly static NOT_SUPPORTED_ERR: 9

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11373

Inherited from

DOMException.NOT_SUPPORTED_ERR

---

QUOTA_EXCEEDED_ERR

readonly static QUOTA_EXCEEDED_ERR: 22

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11386

Inherited from

DOMException.QUOTA_EXCEEDED_ERR

---

SECURITY_ERR

readonly static SECURITY_ERR: 18

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11382

Inherited from

DOMException.SECURITY_ERR

---

SYNTAX_ERR

readonly static SYNTAX_ERR: 12

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11376

Inherited from

DOMException.SYNTAX_ERR

---

TIMEOUT_ERR

readonly static TIMEOUT_ERR: 23

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11387

Inherited from

DOMException.TIMEOUT_ERR

---

TYPE_MISMATCH_ERR

readonly static TYPE_MISMATCH_ERR: 17

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11381

Inherited from

DOMException.TYPE_MISMATCH_ERR

---

URL_MISMATCH_ERR

readonly static URL_MISMATCH_ERR: 21

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11385

Inherited from

DOMException.URL_MISMATCH_ERR

---

VALIDATION_ERR

readonly static VALIDATION_ERR: 16

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11380

Inherited from

DOMException.VALIDATION_ERR

---

WRONG_DOCUMENT_ERR

readonly static WRONG_DOCUMENT_ERR: 4

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:11368

Inherited from

DOMException.WRONG_DOCUMENT_ERR