EventMap

Defined in: src/ports/events.ts:37

Strongly-typed map of every event the library emits. The session owns a MeshCoreEvents instance and exposes it as session.events.

Note: there is intentionally NO generic error event here — the donor app’s errorMessage channel was dropped during extraction. Specific recoverable conditions are surfaced as their own dedicated events instead (e.g. MeshCoreEventMap.contactsFull), which adapters may map onto their own error/toast channel.

Properties

autoAddConfig

autoAddConfig: (cfg) => void;

Defined in: src/ports/events.ts:70

Parameters

Parameter	Type
cfg	AutoAddConfig

Returns

void

---

channelPresence

channelPresence: (keys) => void;

Defined in: src/ports/events.ts:41

Parameters

Parameter	Type
keys	string[]

Returns

void

---

channels

channels: (channels) => void;

Defined in: src/ports/events.ts:40

Parameters

Parameter	Type
channels	Channel[]

Returns

void

---

contactDiscovered

contactDiscovered: (c) => void;

Defined in: src/ports/events.ts:51

Parameters

Parameter	Type
c	{ key: string; kind: ContactKind; name: string; }
c.key	string
c.kind	ContactKind
c.name	string

Returns

void

---

contactEvicted

contactEvicted: (name) => void;

Defined in: src/ports/events.ts:45

Parameters

Parameter	Type
name	string

Returns

void

---

contactObserved

contactObserved: (record, source) => void;

Defined in: src/ports/events.ts:54

Fires whenever a contact record is ingested (sync or advert), exposing the raw decoded record so consumers can persist it themselves.

Parameters

Parameter	Type
record	ContactRecord
source	ContactSource

Returns

void

---

contacts

contacts: (contacts) => void;

Defined in: src/ports/events.ts:43

Parameters

Parameter	Type
contacts	Contact[]

Returns

void

---

contactsFull

contactsFull: () => void;

Defined in: src/ports/events.ts:50

The radio’s contact store is full — a new advert could not be auto-added (overwrite-oldest off, or all slots favourited). Informational/recoverable: the user must remove or favourite contacts to make room. Adapters may bridge this onto their own error/toast channel.

Returns

void

---

deviceCapabilities

deviceCapabilities: (caps) => void;

Defined in: src/ports/events.ts:74

Parameters

Parameter	Type
caps	DeviceCapabilities

Returns

void

---

deviceIdentity

deviceIdentity: (identity) => void;

Defined in: src/ports/events.ts:69

Parameters

Parameter	Type
identity	DeviceIdentity

Returns

void

---

deviceInfo

deviceInfo: (info) => void;

Defined in: src/ports/events.ts:73

Parameters

Parameter	Type
info	DeviceInfo

Returns

void

---

discovered

discovered: (rows) => void;

Defined in: src/ports/events.ts:44

Parameters

Parameter	Type
rows	DiscoveredContact[]

Returns

void

---

gpsConfig

gpsConfig: (cfg) => void;

Defined in: src/ports/events.ts:72

Parameters

Parameter	Type
cfg	GpsConfig

Returns

void

---

messagePathHeard

messagePathHeard: (p) => void;

Defined in: src/ports/events.ts:63

A heard repeater relay of one of your outgoing channel sends, correlated back to the message id you passed to registerChannelSend. Carries only the message id and the observed path — the library does not track message state for this; the consumer owns it.

Parameters

Parameter	Type
p	{ id: string; path: MessagePath; }
p.id	string
p.path	MessagePath

Returns

void

---

messages

messages: (key, messages) => void;

Defined in: src/ports/events.ts:55

Parameters

Parameter	Type
key	string
messages	Message[]

Returns

void

---

messageState

messageState: (id, state) => void;

Defined in: src/ports/events.ts:58

Parameters

Parameter	Type
id	string
state	MessageState

Returns

void

---

messageUpserted

messageUpserted: (message) => void;

Defined in: src/ports/events.ts:57

A single inserted/updated message — a delta companion to messages.

Parameters

Parameter	Type
message	Message

Returns

void

---

owner

owner: (owner) => void;

Defined in: src/ports/events.ts:64

Parameters

Parameter	Type
owner	| Owner | null

Returns

void

---

pathLearned

pathLearned: (event) => void;

Defined in: src/ports/events.ts:68

Parameters

Parameter	Type
event	PathLearnedEvent

Returns

void

---

radioSettings

radioSettings: (settings) => void;

Defined in: src/ports/events.ts:65

Parameters

Parameter	Type
settings	RadioSettings

Returns

void

---

rawPacket

rawPacket: (pkt) => void;

Defined in: src/ports/events.ts:39

Parameters

Parameter	Type
pkt	{ hex: string; rssi: number; snr: number; source: MeshSource; }
pkt.hex	string
pkt.rssi	number
pkt.snr	number
pkt.source	MeshSource

Returns

void

---

repeaterStatus

repeaterStatus: (snap) => void;

Defined in: src/ports/events.ts:66

Parameters

Parameter	Type
snap	RepeaterStatusSnapshot

Returns

void

---

repeaterTelemetry

repeaterTelemetry: (snap) => void;

Defined in: src/ports/events.ts:67

Parameters

Parameter	Type
snap	RepeaterTelemetrySnapshot

Returns

void

---

syncProgress

syncProgress: (progress) => void;

Defined in: src/ports/events.ts:42

Parameters

Parameter	Type
progress	SyncProgress

Returns

void

---

telemetryPolicy

telemetryPolicy: (policy) => void;

Defined in: src/ports/events.ts:71

Parameters

Parameter	Type
policy	TelemetryPolicy

Returns

void

---

transportState

transportState: (s) => void;

Defined in: src/ports/events.ts:38

Parameters

Parameter	Type
s	TransportState

Returns

void