<N, E, T extends Kind = "directed">(
mutable: MutableGraph<N, E, T>
): Graph<N, E, T>Converts a mutable graph back to an immutable graph, ending the mutation scope.
Example (Ending a mutation scope)
import { Graph } from "effect"
const graph = Graph.directed<string, number>()
const mutable = Graph.beginMutation(graph)
// ... perform mutations on mutable ...
const newGraph = Graph.endMutation(mutable)mutations
Source effect/Graph.ts:52516 lines
export const const endMutation: <
N,
E,
T extends Kind = "directed"
>(
mutable: MutableGraph<N, E, T>
) => Graph<N, E, T>
Converts a mutable graph back to an immutable graph, ending the mutation scope.
Example (Ending a mutation scope)
import { Graph } from "effect"
const graph = Graph.directed<string, number>()
const mutable = Graph.beginMutation(graph)
// ... perform mutations on mutable ...
const newGraph = Graph.endMutation(mutable)
endMutation = <function (type parameter) N in <N, E, T extends Kind = "directed">(mutable: MutableGraph<N, E, T>): Graph<N, E, T>N, function (type parameter) E in <N, E, T extends Kind = "directed">(mutable: MutableGraph<N, E, T>): Graph<N, E, T>E, function (type parameter) T in <N, E, T extends Kind = "directed">(mutable: MutableGraph<N, E, T>): Graph<N, E, T>T extends type Kind = "directed" | "undirected"Graph type for distinguishing directed and undirected graphs.
When to use
Use when writing graph-polymorphic types or helpers that need to preserve
whether a graph is directed or undirected.
Kind = "directed">(
mutable: MutableGraph<N, E, T>(parameter) mutable: {
type: T;
mutable: true;
nodes: Map<NodeIndex, N>;
edges: Map<EdgeIndex, Edge<E>>;
adjacency: Map<NodeIndex, Array<EdgeIndex>>;
reverseAdjacency: Map<NodeIndex, Array<EdgeIndex>>;
nextNodeIndex: NodeIndex;
nextEdgeIndex: EdgeIndex;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
interface MutableGraph<out N, out E, T extends Kind = "directed">Mutable graph interface.
When to use
Use when adding, removing, or updating nodes and edges inside a graph
mutation scope.
MutableGraph<function (type parameter) N in <N, E, T extends Kind = "directed">(mutable: MutableGraph<N, E, T>): Graph<N, E, T>N, function (type parameter) E in <N, E, T extends Kind = "directed">(mutable: MutableGraph<N, E, T>): Graph<N, E, T>E, function (type parameter) T in <N, E, T extends Kind = "directed">(mutable: MutableGraph<N, E, T>): Graph<N, E, T>T>
): interface Graph<out N, out E, T extends Kind = "directed">Immutable graph interface.
When to use
Use as the immutable graph model for code that queries, traverses,
transforms, or analyzes graph structure without mutating it.
Graph<function (type parameter) N in <N, E, T extends Kind = "directed">(mutable: MutableGraph<N, E, T>): Graph<N, E, T>N, function (type parameter) E in <N, E, T extends Kind = "directed">(mutable: MutableGraph<N, E, T>): Graph<N, E, T>E, function (type parameter) T in <N, E, T extends Kind = "directed">(mutable: MutableGraph<N, E, T>): Graph<N, E, T>T> => {
const const graph: Mutable<Graph<N, E, T>>const graph: {
type: T;
mutable: false;
nodes: Map<number, N>;
edges: Map<number, Edge<E>>;
adjacency: Map<number, Array<number>>;
reverseAdjacency: Map<number, Array<number>>;
nextNodeIndex: number;
nextEdgeIndex: number;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
type Mutable<T> = { -readonly [P in keyof T]: T[P]; }Removes readonly from all properties of T. Supports arrays, tuples,
and records.
When to use
Use when you need a mutable version of a readonly type.
Details
Only affects the top level; nested properties remain readonly.
Example (Converting shallowly to mutable types)
import type { Types } from "effect"
type Obj = Types.Mutable<{
readonly a: string
readonly b: ReadonlyArray<number>
}>
// { a: string; b: ReadonlyArray<number> }
// ^ mutable ^ still readonly inside
type Arr = Types.Mutable<ReadonlyArray<string>>
// string[]
type Tup = Types.Mutable<readonly [string, number]>
// [string, number]
Mutable<interface Graph<out N, out E, T extends Kind = "directed">Immutable graph interface.
When to use
Use as the immutable graph model for code that queries, traverses,
transforms, or analyzes graph structure without mutating it.
Graph<function (type parameter) N in <N, E, T extends Kind = "directed">(mutable: MutableGraph<N, E, T>): Graph<N, E, T>N, function (type parameter) E in <N, E, T extends Kind = "directed">(mutable: MutableGraph<N, E, T>): Graph<N, E, T>E, function (type parameter) T in <N, E, T extends Kind = "directed">(mutable: MutableGraph<N, E, T>): Graph<N, E, T>T>> = var Object: ObjectConstructorProvides functionality common to all JavaScript objects.
Object.ObjectConstructor.create(o: object | null): any (+1 overload)Creates an object that has the specified prototype or that has null prototype.
create(const ProtoGraph: {
"~effect/collections/Graph": string
[Symbol.iterator](
this: Graph<any, any>
): MapIterator<[number, any]>
[NodeInspectSymbol](
this: Graph<any, any>
): unknown
"~effect/interfaces/Equal"(
this: Graph<any, any>,
that: Equal.Equal
): boolean
"~effect/interfaces/Hash"(
this: Graph<any, any>
): number
toJSON(this: Graph<any, any>): {
_id: string
nodeCount: number
edgeCount: number
type: "directed"
}
toString(this: Graph<any, any>): string
pipe(): unknown
}
const graph: Mutable<Graph<N, E, T>>const graph: {
type: T;
mutable: false;
nodes: Map<number, N>;
edges: Map<number, Edge<E>>;
adjacency: Map<number, Array<number>>;
reverseAdjacency: Map<number, Array<number>>;
nextNodeIndex: number;
nextEdgeIndex: number;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
type: T extends Kind = "directed"type = mutable: MutableGraph<N, E, T>(parameter) mutable: {
type: T;
mutable: true;
nodes: Map<NodeIndex, N>;
edges: Map<EdgeIndex, Edge<E>>;
adjacency: Map<NodeIndex, Array<EdgeIndex>>;
reverseAdjacency: Map<NodeIndex, Array<EdgeIndex>>;
nextNodeIndex: NodeIndex;
nextEdgeIndex: EdgeIndex;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
MutableGraph<N, E, T>.type: T extends Kind = "directed"type
const graph: Mutable<Graph<N, E, T>>const graph: {
type: T;
mutable: false;
nodes: Map<number, N>;
edges: Map<number, Edge<E>>;
adjacency: Map<number, Array<number>>;
reverseAdjacency: Map<number, Array<number>>;
nextNodeIndex: number;
nextEdgeIndex: number;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
nodes: Map<number, N>nodes = new var Map: MapConstructor
new <number, N>(iterable?: Iterable<readonly [number, N]> | null | undefined) => Map<number, N> (+3 overloads)
mutable: MutableGraph<N, E, T>(parameter) mutable: {
type: T;
mutable: true;
nodes: Map<NodeIndex, N>;
edges: Map<EdgeIndex, Edge<E>>;
adjacency: Map<NodeIndex, Array<EdgeIndex>>;
reverseAdjacency: Map<NodeIndex, Array<EdgeIndex>>;
nextNodeIndex: NodeIndex;
nextEdgeIndex: EdgeIndex;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
Proto<N, E>.nodes: Map<NodeIndex, N>nodes)
const graph: Mutable<Graph<N, E, T>>const graph: {
type: T;
mutable: false;
nodes: Map<number, N>;
edges: Map<number, Edge<E>>;
adjacency: Map<number, Array<number>>;
reverseAdjacency: Map<number, Array<number>>;
nextNodeIndex: number;
nextEdgeIndex: number;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
edges: Map<number, Edge<E>>edges = new var Map: MapConstructor
new <number, Edge<E>>(iterable?: Iterable<readonly [number, Edge<E>]> | null | undefined) => Map<number, Edge<E>> (+3 overloads)
mutable: MutableGraph<N, E, T>(parameter) mutable: {
type: T;
mutable: true;
nodes: Map<NodeIndex, N>;
edges: Map<EdgeIndex, Edge<E>>;
adjacency: Map<NodeIndex, Array<EdgeIndex>>;
reverseAdjacency: Map<NodeIndex, Array<EdgeIndex>>;
nextNodeIndex: NodeIndex;
nextEdgeIndex: EdgeIndex;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
Proto<N, E>.edges: Map<EdgeIndex, Edge<E>>edges)
const graph: Mutable<Graph<N, E, T>>const graph: {
type: T;
mutable: false;
nodes: Map<number, N>;
edges: Map<number, Edge<E>>;
adjacency: Map<number, Array<number>>;
reverseAdjacency: Map<number, Array<number>>;
nextNodeIndex: number;
nextEdgeIndex: number;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
adjacency: Map<number, number[]>adjacency = mutable: MutableGraph<N, E, T>(parameter) mutable: {
type: T;
mutable: true;
nodes: Map<NodeIndex, N>;
edges: Map<EdgeIndex, Edge<E>>;
adjacency: Map<NodeIndex, Array<EdgeIndex>>;
reverseAdjacency: Map<NodeIndex, Array<EdgeIndex>>;
nextNodeIndex: NodeIndex;
nextEdgeIndex: EdgeIndex;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
Proto<out N, out E>.adjacency: Map<NodeIndex, Array<EdgeIndex>>adjacency
const graph: Mutable<Graph<N, E, T>>const graph: {
type: T;
mutable: false;
nodes: Map<number, N>;
edges: Map<number, Edge<E>>;
adjacency: Map<number, Array<number>>;
reverseAdjacency: Map<number, Array<number>>;
nextNodeIndex: number;
nextEdgeIndex: number;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
reverseAdjacency: Map<number, number[]>reverseAdjacency = mutable: MutableGraph<N, E, T>(parameter) mutable: {
type: T;
mutable: true;
nodes: Map<NodeIndex, N>;
edges: Map<EdgeIndex, Edge<E>>;
adjacency: Map<NodeIndex, Array<EdgeIndex>>;
reverseAdjacency: Map<NodeIndex, Array<EdgeIndex>>;
nextNodeIndex: NodeIndex;
nextEdgeIndex: EdgeIndex;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
Proto<out N, out E>.reverseAdjacency: Map<NodeIndex, Array<EdgeIndex>>reverseAdjacency
const graph: Mutable<Graph<N, E, T>>const graph: {
type: T;
mutable: false;
nodes: Map<number, N>;
edges: Map<number, Edge<E>>;
adjacency: Map<number, Array<number>>;
reverseAdjacency: Map<number, Array<number>>;
nextNodeIndex: number;
nextEdgeIndex: number;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
nextNodeIndex: numbernextNodeIndex = mutable: MutableGraph<N, E, T>(parameter) mutable: {
type: T;
mutable: true;
nodes: Map<NodeIndex, N>;
edges: Map<EdgeIndex, Edge<E>>;
adjacency: Map<NodeIndex, Array<EdgeIndex>>;
reverseAdjacency: Map<NodeIndex, Array<EdgeIndex>>;
nextNodeIndex: NodeIndex;
nextEdgeIndex: EdgeIndex;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
Proto<out N, out E>.nextNodeIndex: NodeIndexnextNodeIndex
const graph: Mutable<Graph<N, E, T>>const graph: {
type: T;
mutable: false;
nodes: Map<number, N>;
edges: Map<number, Edge<E>>;
adjacency: Map<number, Array<number>>;
reverseAdjacency: Map<number, Array<number>>;
nextNodeIndex: number;
nextEdgeIndex: number;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
nextEdgeIndex: numbernextEdgeIndex = mutable: MutableGraph<N, E, T>(parameter) mutable: {
type: T;
mutable: true;
nodes: Map<NodeIndex, N>;
edges: Map<EdgeIndex, Edge<E>>;
adjacency: Map<NodeIndex, Array<EdgeIndex>>;
reverseAdjacency: Map<NodeIndex, Array<EdgeIndex>>;
nextNodeIndex: NodeIndex;
nextEdgeIndex: EdgeIndex;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
Proto<out N, out E>.nextEdgeIndex: EdgeIndexnextEdgeIndex
const graph: Mutable<Graph<N, E, T>>const graph: {
type: T;
mutable: false;
nodes: Map<number, N>;
edges: Map<number, Edge<E>>;
adjacency: Map<number, Array<number>>;
reverseAdjacency: Map<number, Array<number>>;
nextNodeIndex: number;
nextEdgeIndex: number;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
acyclic: Option.Option<boolean>acyclic = mutable: MutableGraph<N, E, T>(parameter) mutable: {
type: T;
mutable: true;
nodes: Map<NodeIndex, N>;
edges: Map<EdgeIndex, Edge<E>>;
adjacency: Map<NodeIndex, Array<EdgeIndex>>;
reverseAdjacency: Map<NodeIndex, Array<EdgeIndex>>;
nextNodeIndex: NodeIndex;
nextEdgeIndex: EdgeIndex;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
Proto<out N, out E>.acyclic: Option.Option<boolean>acyclic
const graph: Mutable<Graph<N, E, T>>const graph: {
type: T;
mutable: false;
nodes: Map<number, N>;
edges: Map<number, Edge<E>>;
adjacency: Map<number, Array<number>>;
reverseAdjacency: Map<number, Array<number>>;
nextNodeIndex: number;
nextEdgeIndex: number;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
mutable: falsemutable = false
return const graph: Mutable<Graph<N, E, T>>const graph: {
type: T;
mutable: false;
nodes: Map<number, N>;
edges: Map<number, Edge<E>>;
adjacency: Map<number, Array<number>>;
reverseAdjacency: Map<number, Array<number>>;
nextNodeIndex: number;
nextEdgeIndex: number;
acyclic: Option.Option<boolean>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
Referenced by 3 symbols