@blockchaincommons/xid - v1.0.0-beta.3
    Preparing search index...

    Interface XIDErrorDetailsByCode

    The fields each code carries besides code.

    interface XIDErrorDetailsByCode {
        Duplicate: { item: string };
        NotFound: { item: string };
        StillReferenced: { item: string };
        EmptyValue: { field: string };
        UnknownPrivilege: unknown;
        InvalidXid: unknown;
        MissingInceptionKey: unknown;
        InvalidResolutionMethod: unknown;
        MultipleProvenanceMarks: unknown;
        UnexpectedPredicate: { predicate: string };
        UnexpectedNestedAssertions: unknown;
        NoPermissions: { uri: string };
        NoReferences: { uri: string };
        UnknownKeyReference: { reference: string; uri: string };
        UnknownDelegateReference: { reference: string; uri: string };
        KeyNotFoundInDocument: { key: string };
        DelegateNotFoundInDocument: { delegate: string };
        InvalidPassword: unknown;
        EnvelopeNotSigned: unknown;
        SignatureVerificationFailed: unknown;
        NoProvenanceMark: unknown;
        GeneratorConflict: unknown;
        NoGenerator: unknown;
        ChainIdMismatch: { expected: Uint8Array; actual: Uint8Array };
        SequenceMismatch: { expected: number; actual: number };
        EnvelopeParsing: { message: string };
        Component: { message: string };
        Cbor: { message: string };
        ProvenanceMark: { message: string };
    }
    Index
    Duplicate NotFound StillReferenced EmptyValue UnknownPrivilege InvalidXid MissingInceptionKey InvalidResolutionMethod MultipleProvenanceMarks UnexpectedPredicate UnexpectedNestedAssertions NoPermissions NoReferences UnknownKeyReference UnknownDelegateReference KeyNotFoundInDocument DelegateNotFoundInDocument InvalidPassword EnvelopeNotSigned SignatureVerificationFailed NoProvenanceMark GeneratorConflict NoGenerator ChainIdMismatch SequenceMismatch EnvelopeParsing Component Cbor ProvenanceMark
    Duplicate: { item: string }

    An item of this kind is already there.

    Type Declaration

    • Readonlyitem: string

      The item's kind: "key", "delegate", "service", "nickname", …

    NotFound: { item: string }

    No item of this kind is there.

    Type Declaration

    • Readonlyitem: string

      The item's kind.

    StillReferenced: { item: string }

    A service still names the item.

    Type Declaration

    • Readonlyitem: string

      The item's kind.

    EmptyValue: { field: string }

    The field must not be empty.

    Type Declaration

    • Readonlyfield: string

      The field's name.

    UnknownPrivilege: unknown

    A known value that names no privilege.

    InvalidXid: unknown

    The inception key does not produce the document's XID.

    MissingInceptionKey: unknown

    The document has no inception key, or it has no private keys.

    InvalidResolutionMethod: unknown

    A 'dereferenceVia' object that is not a URI.

    MultipleProvenanceMarks: unknown

    More than one 'provenance' assertion.

    UnexpectedPredicate: { predicate: string }

    A service assertion with a predicate the parser does not take.

    Type Declaration

    • Readonlypredicate: string

      The predicate's known value, as decimal text.

    UnexpectedNestedAssertions: unknown

    A service assertion whose object has assertions.

    NoPermissions: { uri: string }

    The service allows nothing.

    Type Declaration

    • Readonlyuri: string

      The service's URI.

    NoReferences: { uri: string }

    The service names no key and no delegate.

    Type Declaration

    • Readonlyuri: string

      The service's URI.

    UnknownKeyReference: { reference: string; uri: string }

    The service names a key the document lacks.

    Type Declaration

    • Readonlyreference: string

      The reference, rendered Reference(<short hex>).

    • Readonlyuri: string

      The service's URI.

    UnknownDelegateReference: { reference: string; uri: string }

    The service names a delegate the document lacks.

    Type Declaration

    • Readonlyreference: string

      The reference, rendered Reference(<short hex>).

    • Readonlyuri: string

      The service's URI.

    KeyNotFoundInDocument: { key: string }

    checkContainsKey found no such key.

    Type Declaration

    • Readonlykey: string

      The key's public keys, rendered.

    DelegateNotFoundInDocument: { delegate: string }

    checkContainsDelegate found no such delegate.

    Type Declaration

    • Readonlydelegate: string

      The delegate's XID, rendered.

    InvalidPassword: unknown

    A locked key or generator did not open.

    EnvelopeNotSigned: unknown

    Verification was asked of an unsigned envelope.

    SignatureVerificationFailed: unknown

    The inception key did not sign the envelope.

    NoProvenanceMark: unknown

    The document has no mark to advance.

    GeneratorConflict: unknown

    A generator was given to a document that holds one.

    NoGenerator: unknown

    The document holds no generator and none was given.

    ChainIdMismatch: { expected: Uint8Array; actual: Uint8Array }

    The generator continues another chain.

    Type Declaration

    • Readonlyexpected: Uint8Array

      The mark's chain id.

    • Readonlyactual: Uint8Array

      The generator's chain id.

    SequenceMismatch: { expected: number; actual: number }

    The generator's next sequence number is not the mark's plus one.

    Type Declaration

    • Readonlyexpected: number

      The sequence number the mark demands.

    • Readonlyactual: number

      The generator's next sequence number.

    EnvelopeParsing: { message: string }

    An envelope error inside a decoder; the error itself is cause.

    Type Declaration

    • Readonlymessage: string

      The envelope error's message.

    Component: { message: string }

    A components error; the error itself is cause.

    Type Declaration

    • Readonlymessage: string

      The components error's message.

    Cbor: { message: string }

    A dcbor error inside a decoder; the error itself is cause.

    Type Declaration

    • Readonlymessage: string

      The dcbor error's message.

    ProvenanceMark: { message: string }

    A provenance-mark error; the error itself is cause.

    Type Declaration

    • Readonlymessage: string

      The provenance-mark error's message.

    Settings
    Member Visibility

    On This Page
    Properties