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;
}

Index

Methods

edges edgesMut addEdge getEdge removeEdge clearEdges hasEdges

Methods

edges

edges(): Edges
Returns a reference to the edges container.

Returns Edges
- Defined in envelope/src/extension/edge.ts:167

edgesMut

edgesMut(): Edges
Returns a mutable reference to the edges container.

Returns Edges
- Defined in envelope/src/extension/edge.ts:169

addEdge

addEdge(edgeEnvelope: Envelope): void
Adds a pre-constructed edge envelope.
Parameters
- edgeEnvelope: Envelope
Returns void
- Defined in envelope/src/extension/edge.ts:171

getEdge

getEdge(digest: Digest): Envelope | undefined
Retrieves an edge by its digest.
Parameters
- digest: Digest
Returns Envelope | undefined
- Defined in envelope/src/extension/edge.ts:173

removeEdge

removeEdge(digest: Digest): Envelope | undefined
Removes an edge by its digest.
Parameters
- digest: Digest
Returns Envelope | undefined
- Defined in envelope/src/extension/edge.ts:175

clearEdges

clearEdges(): void
Removes all edges.

Returns void
- Defined in envelope/src/extension/edge.ts:177

hasEdges

hasEdges(): boolean
Returns whether the object has any edges.

Returns boolean
- Defined in envelope/src/extension/edge.ts:179