Skip to content

@mega-yfue/eufy-sdk / CapabilityDescriptor

Interface: CapabilityDescriptor ​

What one capability exposes on a device — the join of its bound object and its own declaration.

Properties ​

accessor? ​

ts
accessor?: string;

The fluent accessor this capability is reached under: dev[accessor]().

Absent for a capability with nothing to bind — one whose whole surface is inbound events, so it declares no members and no actions() and therefore has no object to reach. Such a capability is described for its events alone; every other field is empty.


actions ​

ts
actions: readonly ActionDescriptor[];

The installed actions that carry a description.


capability ​

ts
capability: Capability;

events ​

ts
events: readonly string[];

The semantic event names this capability emits.


reads ​

ts
reads: readonly ReadDescriptor[];

The reads INSTALLED on this device, never the theoretical set.


undescribedActions ​

ts
undescribedActions: readonly string[];

Installed, callable actions with no description — usable, but not auto-offerable. Published rather than hidden so the gap is visible instead of looking like the action doesn't exist.

Independent and unofficial. Not affiliated with, endorsed by, or sponsored by Anker Innovations, Anker eufy, or eufy. "Anker eufy", "eufy" and "Anker" are trademarks of their respective owners. Use responsibly — rapid or failed logins can trigger captcha or temporary cooldowns.