Blockchain Commons XID TypeScript Library - v1.0.0-alpha.20
    Preparing search index...

    Class Edges

    A container for edge envelopes on a document.

    Edges stores pre-constructed edge envelopes keyed by their digest, mirroring the Attachments container but for edges as defined in BCR-2026-003.

    Equivalent to Rust's Edges struct in src/extension/edge/edges.rs.

    Index

    Constructors

    • Creates a new empty edges container.

      Returns Edges

    Methods

    • Adds a pre-constructed edge envelope.

      Parameters

      • edgeEnvelope: Envelope

        The edge envelope to add

      Returns void

    • Retrieves an edge by its digest.

      Parameters

      • digest: Digest

        The digest of the edge to retrieve

      Returns Envelope | undefined

      The edge envelope if found, or undefined

    • Removes an edge by its digest.

      Parameters

      • digest: Digest

        The digest of the edge to remove

      Returns Envelope | undefined

      The removed edge envelope if found, or undefined

    • Removes all edges from the container.

      Returns void

    • Returns whether the container has no edges.

      Returns boolean

    • Returns the number of edges in the container.

      Returns number

    • Returns an iterator over all edge envelopes.

      Returns IterableIterator<[string, Envelope]>

    • Check equality with another Edges container.

      Parameters

      Returns boolean

    • Adds all edges as 'edge' assertion envelopes to the given envelope.

      Parameters

      • envelope: Envelope

        The envelope to add edges to

      Returns Envelope

      A new envelope with all edges added as assertions

    • Extracts edges from an envelope's 'edge' assertions.

      Equivalent to Rust's Edges::try_from_envelope().

      Parameters

      • envelope: Envelope

        The envelope to extract edges from

      Returns Edges

      A new Edges container with the envelope's edges