@blockchaincommons/envelope - v1.0.0-beta.4
    Preparing search index...

    Variable EnvelopeErrorCodeConst

    EnvelopeErrorCode: {
        AlreadyElided: "AlreadyElided";
        AmbiguousPredicate: "AmbiguousPredicate";
        InvalidDigest: "InvalidDigest";
        InvalidFormat: "InvalidFormat";
        MissingDigest: "MissingDigest";
        NonexistentPredicate: "NonexistentPredicate";
        NotWrapped: "NotWrapped";
        NotLeaf: "NotLeaf";
        NotAssertion: "NotAssertion";
        InvalidAssertion: "InvalidAssertion";
        InvalidAttachment: "InvalidAttachment";
        NonexistentAttachment: "NonexistentAttachment";
        AmbiguousAttachment: "AmbiguousAttachment";
        EdgeMissingIsA: "EdgeMissingIsA";
        EdgeMissingSource: "EdgeMissingSource";
        EdgeMissingTarget: "EdgeMissingTarget";
        EdgeDuplicateIsA: "EdgeDuplicateIsA";
        EdgeDuplicateSource: "EdgeDuplicateSource";
        EdgeDuplicateTarget: "EdgeDuplicateTarget";
        EdgeUnexpectedAssertion: "EdgeUnexpectedAssertion";
        NonexistentEdge: "NonexistentEdge";
        AmbiguousEdge: "AmbiguousEdge";
        AlreadyCompressed: "AlreadyCompressed";
        NotCompressed: "NotCompressed";
        AlreadyEncrypted: "AlreadyEncrypted";
        NotEncrypted: "NotEncrypted";
        NotKnownValue: "NotKnownValue";
        UnknownRecipient: "UnknownRecipient";
        UnknownSecret: "UnknownSecret";
        UnverifiedSignature: "UnverifiedSignature";
        InvalidOuterSignatureType: "InvalidOuterSignatureType";
        InvalidInnerSignatureType: "InvalidInnerSignatureType";
        UnverifiedInnerSignature: "UnverifiedInnerSignature";
        InvalidSignatureType: "InvalidSignatureType";
        InvalidShares: "InvalidShares";
        Sskr: "Sskr";
        InvalidType: "InvalidType";
        AmbiguousType: "AmbiguousType";
        SubjectNotUnit: "SubjectNotUnit";
        UnexpectedResponseId: "UnexpectedResponseId";
        InvalidResponse: "InvalidResponse";
        Cbor: "Cbor";
        Components: "Components";
        InvalidParameter: "InvalidParameter";
        General: "General";
    } = ...

    Every code an EnvelopeError can carry; see each member for when it is raised.

    Type Declaration

    • ReadonlyAlreadyElided: "AlreadyElided"

      The part is already elided.

    • ReadonlyAmbiguousPredicate: "AmbiguousPredicate"

      More than one assertion has the predicate.

    • ReadonlyInvalidDigest: "InvalidDigest"

      A digest in the wire form does not match the recomputed one.

    • ReadonlyInvalidFormat: "InvalidFormat"

      The CBOR is not a well-formed envelope.

    • ReadonlyMissingDigest: "MissingDigest"

      An expected digest is absent.

    • ReadonlyNonexistentPredicate: "NonexistentPredicate"

      No assertion has the predicate.

    • ReadonlyNotWrapped: "NotWrapped"

      The envelope is not a wrapper.

    • ReadonlyNotLeaf: "NotLeaf"

      The subject is not a leaf.

    • ReadonlyNotAssertion: "NotAssertion"

      The envelope is not an assertion.

    • ReadonlyInvalidAssertion: "InvalidAssertion"

      The assertion's wire form is malformed.

    • ReadonlyInvalidAttachment: "InvalidAttachment"

      The attachment's structure is malformed.

    • ReadonlyNonexistentAttachment: "NonexistentAttachment"

      No attachment matches.

    • ReadonlyAmbiguousAttachment: "AmbiguousAttachment"

      More than one attachment matches.

    • ReadonlyEdgeMissingIsA: "EdgeMissingIsA"

      The edge has no isA assertion.

    • ReadonlyEdgeMissingSource: "EdgeMissingSource"

      The edge has no source assertion.

    • ReadonlyEdgeMissingTarget: "EdgeMissingTarget"

      The edge has no target assertion.

    • ReadonlyEdgeDuplicateIsA: "EdgeDuplicateIsA"

      The edge has more than one isA assertion.

    • ReadonlyEdgeDuplicateSource: "EdgeDuplicateSource"

      The edge has more than one source assertion.

    • ReadonlyEdgeDuplicateTarget: "EdgeDuplicateTarget"

      The edge has more than one target assertion.

    • ReadonlyEdgeUnexpectedAssertion: "EdgeUnexpectedAssertion"

      The edge carries an assertion that is not isA, source or target.

    • ReadonlyNonexistentEdge: "NonexistentEdge"

      No edge matches.

    • ReadonlyAmbiguousEdge: "AmbiguousEdge"

      More than one edge matches.

    • ReadonlyAlreadyCompressed: "AlreadyCompressed"

      The part is already compressed.

    • ReadonlyNotCompressed: "NotCompressed"

      The part is not compressed.

    • ReadonlyAlreadyEncrypted: "AlreadyEncrypted"

      The part is already encrypted.

    • ReadonlyNotEncrypted: "NotEncrypted"

      The part is not encrypted.

    • ReadonlyNotKnownValue: "NotKnownValue"

      The subject is not a known value.

    • ReadonlyUnknownRecipient: "UnknownRecipient"

      No hasRecipient assertion opens with the given key.

    • ReadonlyUnknownSecret: "UnknownSecret"

      No hasSecret assertion opens with the given secret.

    • ReadonlyUnverifiedSignature: "UnverifiedSignature"

      No signature verifies for the given key.

    • ReadonlyInvalidOuterSignatureType: "InvalidOuterSignatureType"

      The outer signature of a signed-with-metadata assertion is not a Signature.

    • ReadonlyInvalidInnerSignatureType: "InvalidInnerSignatureType"

      The inner signature of a signed-with-metadata assertion is not a Signature.

    • ReadonlyUnverifiedInnerSignature: "UnverifiedInnerSignature"

      The inner signature of a signed-with-metadata assertion does not verify.

    • ReadonlyInvalidSignatureType: "InvalidSignatureType"

      The signed object is not a Signature.

    • ReadonlyInvalidShares: "InvalidShares"

      The SSKR shares are empty or not all from the same split.

    • ReadonlySskr: "Sskr"

      The SSKR library rejected the shares.

    • ReadonlyInvalidType: "InvalidType"

      The envelope does not carry the expected isA type.

    • ReadonlyAmbiguousType: "AmbiguousType"

      The envelope has zero or several isA types where exactly one was required.

    • ReadonlySubjectNotUnit: "SubjectNotUnit"

      The subject is not the unit known value.

    • ReadonlyUnexpectedResponseId: "UnexpectedResponseId"

      The response's id does not match the request's.

    • ReadonlyInvalidResponse: "InvalidResponse"

      The response's structure is malformed.

    • ReadonlyCbor: "Cbor"

      The CBOR layer rejected the bytes (wrapped CborError).

    • ReadonlyComponents: "Components"

      The components layer rejected the input (wrapped ComponentsError).

    • ReadonlyInvalidParameter: "InvalidParameter"

      A JavaScript-only input the reference's types make impossible (a fractional index, a NaN date, an empty name).

    • ReadonlyGeneral: "General"

      Any other failure; see the message.