Class AddressApi

Index

Constructors

Methods

coveringLocalityOf deregisterLocality findByAddress findByPath rebuildCoverageIndex registerLocality resolveFor resolveLocalityFor traceResolveFor

Constructors

constructor

new AddressApi(): AddressApi
Returns AddressApi

Methods

`Static`coveringLocalityOf

coveringLocalityOf(address: string): default | null
Sync longest-prefix match for an already-known address string — no containment walk, no zone await. The fast-path a consumer uses after resolving the address once. null when uncovered.
Parameters
- address: string
Returns default | null
- Defined in packages/server/src/mud/api/address.ts:112

`Static`deregisterLocality

deregisterLocality(locality: default): void
Remove a Locality from the index (onDestruct / HMR).
Parameters
- locality: default
Returns void
- Defined in packages/server/src/mud/api/address.ts:132

`Static`findByAddress

findByAddress(address: string): default | null
The Locality claiming exactly address, or null. Exact-match.
Parameters
- address: string
Returns default | null
- Defined in packages/server/src/mud/api/address.ts:117

`Static`findByPath

findByPath(path: string): default | null
Resolve a Locality singleton by its templatePath (HMR-safe).
Parameters
- path: string
Returns default | null
- Defined in packages/server/src/mud/api/address.ts:122

`Static`rebuildCoverageIndex

rebuildCoverageIndex(): Promise<void>
Drop + rebuild the coverage index from the Locality roster.

Returns Promise<void>
- Defined in packages/server/src/mud/api/address.ts:137

`Static`registerLocality

registerLocality(locality: default): void
Index a Locality's claimed prefix (Locality self-registration).
Parameters
- locality: default
Returns void
- Defined in packages/server/src/mud/api/address.ts:127

`Static`resolveFor

resolveFor(scope: Stuff & Container): Promise<AddressResolution>
Full resolution bundle (locality + matched address + which step).
Parameters
- scope: Stuff & Container
Returns Promise<AddressResolution>
- Defined in packages/server/src/mud/api/address.ts:94

`Static`resolveLocalityFor

resolveLocalityFor(scope: Stuff & Container): Promise<default | null>
The load-bearing read. Returns the most-specific Locality covering scope's resolved address, or null (global). Never throws; the resolve chain is containment-outward → zone fallthrough → longest-prefix → null. Async because the zone step awaits Zone.lookupField.
Parameters
- scope: Stuff & Container
Returns Promise<default | null>
- Defined in packages/server/src/mud/api/address.ts:87

`Static`traceResolveFor

traceResolveFor(scope: Stuff & Container): Promise<AddressTrace>
The analyze address provenance variant — full trace.
Parameters
- scope: Stuff & Container
Returns Promise<AddressTrace>
- Defined in packages/server/src/mud/api/address.ts:101