Class XIDError

Hierarchy

Error
- XIDError

Constructors

constructor

new XIDError(code: XIDErrorCode, message: string, cause?: Error): XIDError
Parameters
- code: XIDErrorCode
- message: string
- Optionalcause: Error
Returns XIDError
Overrides Error.constructor
- Defined in xid/src/error.ts:44

Properties

`Readonly`code

code: XIDErrorCode

`Optional` `Readonly`cause

cause?: Error

Methods

`Static`duplicate

duplicate(item: string): XIDError
Returned when attempting to add a duplicate item.
Parameters
- item: string
Returns XIDError
- Defined in xid/src/error.ts:65

`Static`notFound

notFound(item: string): XIDError
Returned when an item is not found.
Parameters
- item: string
Returns XIDError
- Defined in xid/src/error.ts:72

`Static`stillReferenced

stillReferenced(item: string): XIDError
Returned when an item is still referenced by other items.
Parameters
- item: string
Returns XIDError
- Defined in xid/src/error.ts:79

`Static`emptyValue

emptyValue(field: string): XIDError
Returned when a value is invalid or empty.
Parameters
- field: string
Returns XIDError
- Defined in xid/src/error.ts:86

`Static`unknownPrivilege

unknownPrivilege(): XIDError
Returned when an unknown privilege is encountered.

Returns XIDError
- Defined in xid/src/error.ts:93

`Static`invalidXid

invalidXid(): XIDError
Returned when the XID is invalid.

Returns XIDError
- Defined in xid/src/error.ts:100

`Static`missingInceptionKey

missingInceptionKey(): XIDError
Returned when the inception key is missing.

Returns XIDError
- Defined in xid/src/error.ts:107

`Static`invalidResolutionMethod

invalidResolutionMethod(): XIDError
Returned when the resolution method is invalid.

Returns XIDError
- Defined in xid/src/error.ts:114

`Static`multipleProvenanceMarks

multipleProvenanceMarks(): XIDError
Returned when multiple provenance marks are found.

Returns XIDError
- Defined in xid/src/error.ts:121

`Static`unexpectedPredicate

unexpectedPredicate(predicate: string): XIDError
Returned when an unexpected predicate is encountered.
Parameters
- predicate: string
Returns XIDError
- Defined in xid/src/error.ts:128

`Static`unexpectedNestedAssertions

unexpectedNestedAssertions(): XIDError
Returned when unexpected nested assertions are found.

Returns XIDError
- Defined in xid/src/error.ts:135

`Static`noPermissions

noPermissions(uri: string): XIDError
Returned when a service has no permissions.
Parameters
- uri: string
Returns XIDError
- Defined in xid/src/error.ts:142

`Static`noReferences

noReferences(uri: string): XIDError
Returned when a service has no key or delegate references.
Parameters
- uri: string
Returns XIDError
- Defined in xid/src/error.ts:149

`Static`unknownKeyReference

unknownKeyReference(reference: string, uri: string): XIDError
Returned when an unknown key reference is found in a service.
Parameters
- reference: string
- uri: string
Returns XIDError
- Defined in xid/src/error.ts:159

`Static`unknownDelegateReference

unknownDelegateReference(reference: string, uri: string): XIDError
Returned when an unknown delegate reference is found in a service.
Parameters
- reference: string
- uri: string
Returns XIDError
- Defined in xid/src/error.ts:169

`Static`keyNotFoundInDocument

keyNotFoundInDocument(key: string): XIDError
Returned when a key is not found in the XID document.
Parameters
- key: string
Returns XIDError
- Defined in xid/src/error.ts:179

`Static`delegateNotFoundInDocument

delegateNotFoundInDocument(delegate: string): XIDError
Returned when a delegate is not found in the XID document.
Parameters
- delegate: string
Returns XIDError
- Defined in xid/src/error.ts:189

`Static`invalidPassword

invalidPassword(): XIDError
Returned when the password is invalid.

Returns XIDError
- Defined in xid/src/error.ts:199

`Static`envelopeNotSigned

envelopeNotSigned(): XIDError
Returned when the envelope is not signed.

Returns XIDError
- Defined in xid/src/error.ts:206

`Static`signatureVerificationFailed

signatureVerificationFailed(): XIDError
Returned when signature verification fails.

Returns XIDError
- Defined in xid/src/error.ts:213

`Static`noProvenanceMark

noProvenanceMark(): XIDError
Returned when there is no provenance mark to advance.

Returns XIDError
- Defined in xid/src/error.ts:223

`Static`generatorConflict

generatorConflict(): XIDError
Returned when document already has generator but external generator was provided.

Returns XIDError
- Defined in xid/src/error.ts:230

`Static`noGenerator

noGenerator(): XIDError
Returned when document does not have generator but needs one.

Returns XIDError
- Defined in xid/src/error.ts:240

`Static`chainIdMismatch

chainIdMismatch(expected: Uint8Array, actual: Uint8Array): XIDError
Returned when generator chain ID doesn't match.
Parameters
- expected: Uint8Array
- actual: Uint8Array
Returns XIDError
- Defined in xid/src/error.ts:250

`Static`sequenceMismatch

sequenceMismatch(expected: number, actual: number): XIDError
Returned when generator sequence doesn't match.
Parameters
- expected: number
- actual: number
Returns XIDError
- Defined in xid/src/error.ts:266

`Static`envelopeParsing

envelopeParsing(cause?: Error): XIDError
Envelope parsing error wrapper.
Parameters
- Optionalcause: Error
Returns XIDError
- Defined in xid/src/error.ts:276

`Static`component

component(cause?: Error): XIDError
Component error wrapper.
Parameters
- Optionalcause: Error
Returns XIDError
- Defined in xid/src/error.ts:283

`Static`cbor

cbor(cause?: Error): XIDError
CBOR error wrapper.
Parameters
- Optionalcause: Error
Returns XIDError
- Defined in xid/src/error.ts:290

`Static`provenanceMark

provenanceMark(cause?: Error): XIDError
Provenance mark error wrapper.
Parameters
- Optionalcause: Error
Returns XIDError
- Defined in xid/src/error.ts:297