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

    Interface Edgeable

    A trait for types that can have edges.

    Edgeable provides a consistent interface for working with edges. Types implementing this interface can store and retrieve edge envelopes representing verifiable claims as defined in BCR-2026-003.

    Equivalent to Rust's Edgeable trait in src/extension/edge/edges.rs.

    interface Edgeable {
        edges(): Edges;
        edgesMut(): Edges;
        addEdge(edgeEnvelope: Envelope): void;
        getEdge(digest: Digest): Envelope | undefined;
        removeEdge(digest: Digest): Envelope | undefined;
        clearEdges(): void;
        hasEdges(): boolean;
    }

    Implemented by

    Index

    Methods

    edges edgesMut addEdge getEdge removeEdge clearEdges hasEdges

    Methods

    • Returns a reference to the edges container.

      Returns Edges

    • Returns a mutable reference to the edges container.

      Returns Edges

    • Adds a pre-constructed edge envelope.

      Parameters

      • edgeEnvelope: Envelope

      Returns void

    • Retrieves an edge by its digest.

      Parameters

      • digest: Digest

      Returns Envelope | undefined

    • Removes an edge by its digest.

      Parameters

      • digest: Digest

      Returns Envelope | undefined

    • Removes all edges.

      Returns void

    • Returns whether the object has any edges.

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Methods