Interface Edgeable

A type that carries edges (the reference's Edgeable trait); XID documents implement it.

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
The edges container.

Returns Edges
- Defined in extension/edge.ts:150

edgesMut

edgesMut(): Edges
The edges container, for mutation.

Returns Edges
- Defined in extension/edge.ts:152

addEdge

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

getEdge

getEdge(digest: Digest): Envelope | undefined
The edge with digest, or undefined.
Parameters
- digest: Digest
Returns Envelope | undefined
- Defined in extension/edge.ts:156

removeEdge

removeEdge(digest: Digest): Envelope | undefined
Removes and returns the edge with digest, or undefined.
Parameters
- digest: Digest
Returns Envelope | undefined
- Defined in extension/edge.ts:158

clearEdges

clearEdges(): void
Removes every edge.

Returns void
- Defined in extension/edge.ts:160

hasEdges

hasEdges(): boolean
true when there is at least one edge.

Returns boolean
- Defined in extension/edge.ts:162