Class RegionGraph

Methods

`Static`create

create(opts?: RegionGraphOptions): RegionGraph
Parameters
- opts: RegionGraphOptions = {}
Returns RegionGraph
- Defined in runtime/region-graph.ts:92

addZone

addZone(id: string, data?: Record<string, unknown>): boolean
Parameters
- id: string
- Optionaldata: Record<string, unknown>
Returns boolean
- Defined in runtime/region-graph.ts:98

removeZone

removeZone(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/region-graph.ts:112

hasZone

hasZone(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/region-graph.ts:142

zones

zones(): string[]
Returns string[]
- Defined in runtime/region-graph.ts:146

zoneCount

zoneCount(): number
Returns number
- Defined in runtime/region-graph.ts:157

getZone

getZone(id: string): ZoneNode | null
Parameters
- id: string
Returns ZoneNode | null
- Defined in runtime/region-graph.ts:159

addConnection

addConnection(edge: RegionEdge): boolean
Parameters
- edge: RegionEdge
Returns boolean
- Defined in runtime/region-graph.ts:169

addBidirectional

addBidirectional(
    fromZone: string,
    toZone: string,
    opts?: RegionBidirectionalOptions,
): boolean
Parameters
- fromZone: string
- toZone: string
- opts: RegionBidirectionalOptions = {}
Returns boolean
- Defined in runtime/region-graph.ts:194

removeConnection

removeConnection(fromZone: string, toZone: string): boolean
Parameters
- fromZone: string
- toZone: string
Returns boolean
- Defined in runtime/region-graph.ts:212

hasConnection

hasConnection(fromZone: string, toZone: string): boolean
Parameters
- fromZone: string
- toZone: string
Returns boolean
- Defined in runtime/region-graph.ts:225

getConnection

getConnection(fromZone: string, toZone: string): RegionEdge | null
Parameters
- fromZone: string
- toZone: string
Returns RegionEdge | null
- Defined in runtime/region-graph.ts:230

edges

edges(): RegionEdge[]
Returns RegionEdge[]
- Defined in runtime/region-graph.ts:237

edgeCount

edgeCount(): number
Returns number
- Defined in runtime/region-graph.ts:254

neighbors

neighbors(zone: string, ctx?: Record<string, unknown>): string[]
Parameters
- zone: string
- ctx: Record<string, unknown> = {}
Returns string[]
- Defined in runtime/region-graph.ts:259

shortestPath

shortestPath(
    fromZone: string,
    toZone: string,
    ctx?: Record<string, unknown>,
): string[] | null
Parameters
- fromZone: string
- toZone: string
- ctx: Record<string, unknown> = {}
Returns string[] | null
- Defined in runtime/region-graph.ts:277

reachable

reachable(fromZone: string, ctx?: Record<string, unknown>): string[]
Parameters
- fromZone: string
- ctx: Record<string, unknown> = {}
Returns string[]
- Defined in runtime/region-graph.ts:328

isReachable

isReachable(
    fromZone: string,
    toZone: string,
    ctx?: Record<string, unknown>,
): boolean
Parameters
- fromZone: string
- toZone: string
- ctx: Record<string, unknown> = {}
Returns boolean
- Defined in runtime/region-graph.ts:358

clear

clear(): void
Returns void
- Defined in runtime/region-graph.ts:366

dispose

dispose(): void
Returns void
- Defined in runtime/region-graph.ts:372