Class Wifi

WiFi Service

Manages WiFi device state and access points.

Fires

changed - Emitted when WiFi state changes

Hierarchy (View Summary)

default
- Wifi

Implements

Disposable

Index

Accessors

access_points

get access_points(): AccessPointInfo[]
List of visible access points with their SSID, strength, frequency, and status.

Returns AccessPointInfo[]
- Defined in src/service/network.ts:240

enabled

get enabled(): boolean
Whether Wi-Fi is enabled on the adapter.

Returns boolean
- Defined in src/service/network.ts:260
set enabled(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in src/service/network.ts:264

frequency

get frequency(): number
Frequency in MHz of the active access point (-1 if none).

Returns number
- Defined in src/service/network.ts:274

icon_name

get icon_name(): string
Symbolic icon name reflecting Wi-Fi state and signal strength.

Returns string
- Defined in src/service/network.ts:299

internet

get internet(): "connecting" | "connected" | "disconnected"
Internet connectivity state: "connected", "connecting", or "disconnected".

Returns "connecting" | "connected" | "disconnected"
- Defined in src/service/network.ts:279

isDisposed

get isDisposed(): boolean
Check if service has been disposed

Returns boolean
Inherited from Service.isDisposed
- Defined in src/service.ts:411

ssid

get ssid(): string
SSID of the active access point (empty string if none).

Returns string
- Defined in src/service/network.ts:284

state

get state(): | "failed"
| "disconnected"
| "unmanaged"
| "unavailable"
| "prepare"
| "config"
| "need_auth"
| "ip_config"
| "ip_check"
| "secondaries"
| "activated"
| "deactivating"
| "unknown"
NM device state string (e.g. "activated", "disconnected").

Returns
    | "failed"
    | "disconnected"
    | "unmanaged"
    | "unavailable"
    | "prepare"
    | "config"
    | "need_auth"
    | "ip_config"
    | "ip_check"
    | "secondaries"
    | "activated"
    | "deactivating"
    | "unknown"
- Defined in src/service/network.ts:294

strength

get strength(): number
Signal strength of the active access point (0-100, or -1 if none).

Returns number
- Defined in src/service/network.ts:269

Constructors

constructor

new Wifi(client: Client, device: DeviceWifi): Wifi
Parameters
- client: Client
- device: DeviceWifi
Returns Wifi
Overrides default.constructor
- Defined in src/service/network.ts:172

Methods

bind

bind<
    Prop extends
        | "frequency"
        | "icon_name"
        | "isDisposed"
        | "$signals"
        | "state"
        | "enabled"
        | "access_points"
        | "strength"
        | "internet"
        | "ssid",
>(
    prop: Prop,
): Binding<Wifi, Prop, Wifi[Prop]>
Creates a Binding for a property on this service.
Type Parameters
- Prop extends
      | "frequency"
      | "icon_name"
      | "isDisposed"
      | "$signals"
      | "state"
      | "enabled"
      | "access_points"
      | "strength"
      | "internet"
      | "ssid"
Parameters
- prop: Prop
  The property to bind
Returns Binding<Wifi, Prop, Wifi[Prop]>
A Binding that can be used in widget constructors
Example
```
const label = Widget.Label({
    label: audio.bind('volume').as(v => `${Math.round(v * 100)}%`),
});
```
Inherited from default.bind
- Defined in src/service.ts:348

changed

changed(property: string): void
Notifies listeners that a property changed and emits the 'changed' signal.
Parameters
- property: string
  The property name that changed
Returns void
Inherited from default.changed
- Defined in src/service.ts:330

connect

connect(signal?: string, callback: (_: this, ...args: any[]) => void): number
Connects a callback to a signal on this service.
Parameters
- signal: string = 'changed'
  The signal name (defaults to 'changed')
- callback: (_: this, ...args: any[]) => void
  The callback to invoke when the signal is emitted
Returns number
The signal connection ID
Inherited from default.connect
- Defined in src/service.ts:272

diffBind

diffBind<
    Item,
    Prop extends

            | "frequency"
            | "icon_name"
            | "isDisposed"
            | "$signals"
            | "state"
            | "enabled"
            | "access_points"
            | "strength"
            | "internet"
            | "ssid",
>(
    prop: Prop,
    opts: {
        create: (item: Item) => Widget;
        key: (item: Item) => string | number;
        update?: (widget: Widget, item: Item) => void;
    },
): Binding<Wifi, Prop, Widget[]>
Creates an incremental list binding that reuses existing widgets.

Instead of recreating all widgets on every update, this method caches widgets by a key function and only creates new widgets for new items, destroying widgets for removed items.
Type Parameters
- Item
- Prop extends
      | "frequency"
      | "icon_name"
      | "isDisposed"
      | "$signals"
      | "state"
      | "enabled"
      | "access_points"
      | "strength"
      | "internet"
      | "ssid"
Parameters
- prop: Prop
  The property containing the item array
- opts: {
      create: (item: Item) => Widget;
      key: (item: Item) => string | number;
      update?: (widget: Widget, item: Item) => void;
  }
  Key extractor, widget factory, and optional update callback
Returns Binding<Wifi, Prop, Widget[]>
A Binding that produces an array of widgets
Example
```
const children = audio.diffBind('speakers', {
    key: (s) => s.name,
    create: (s) => Widget.Label({ label: s.description }),
    update: (w, s) => { w.label = s.description; },
});
```
Inherited from default.diffBind
- Defined in src/service.ts:472

`Protected`disconnectAll

disconnectAll(): void
Clean up all tracked signal connections Call this in service-specific dispose implementations

Returns void
Inherited from default.disconnectAll
- Defined in src/service.ts:380

dispose

dispose(): void
Dispose of service resources Override in subclasses to add specific cleanup

Returns void
Implementation of Disposable.dispose
Overrides default.dispose
- Defined in src/service/network.ts:323

emit

emit(signal: string, ...args: any[]): void
Emits a signal, warning if the signal was not registered via Service.register.

The warning is cheap (a Set lookup per emit) and helps catch typos and missing signal declarations that silently break .bind().
Parameters
- signal: string
- ...args: any[]
Returns void
Inherited from default.emit
- Defined in src/service.ts:283

`Protected`retryWithBackoff

retryWithBackoff<T>(
    operation: () => Promise<T>,
    maxRetries?: number,
    baseDelay?: number,
): Promise<T>
Retry a DBus operation with exponential backoff
Type Parameters
- T
Parameters
- operation: () => Promise<T>
- maxRetries: number = 3
- baseDelay: number = 100
Returns Promise<T>
Inherited from default.retryWithBackoff
- Defined in src/service.ts:418

`Readonly`scan

scan(): void
Triggers an asynchronous Wi-Fi access point scan.

Returns void
- Defined in src/service/network.ts:204

`Protected`trackConnection

trackConnection(emitter: Object, id: number): void
Track a signal connection for automatic cleanup
Parameters
- emitter: Object
  The object the signal is connected to (defaults to this)
- id: number
  The signal connection ID
Returns void
Inherited from default.trackConnection
- Defined in src/service.ts:361
trackConnection(id: number): void
Track a signal connection for automatic cleanup
Parameters
- id: number
  The signal connection ID
Returns void
Inherited from default.trackConnection
- Defined in src/service.ts:362

updateProperty

updateProperty(prop: string, value: unknown): void
Updates a property value and emits a notify signal if the value changed.

Performs a deep equality check via JSON serialization to avoid unnecessary notifications.
Parameters
- prop: string
  The property name in kebab-case
- value: unknown
  The new value
Returns void
Inherited from default.updateProperty
- Defined in src/service.ts:315

`Static`import

import<S extends keyof Services>(service: S): Promise<Services[S]>
Dynamically imports a built-in service by name.
Type Parameters
- S extends keyof Services
Parameters
- service: S
  The service name to import
Returns Promise<Services[S]>
The default export of the service module
Example
```
const Audio = await Service.import('audio');
const Battery = await Service.import('battery');
```
Inherited from default.import
- Defined in src/service.ts:234

`Static`pspec

pspec(name: string, type?: PspecType, handle?: PspecFlag): ParamSpec<unknown>
Creates a GObject property specification.
Parameters
- name: string
  The property name in kebab-case
- type: PspecType = 'jsobject'
  The property type (defaults to 'jsobject')
- handle: PspecFlag = 'r'
  The access flag: 'r', 'w', or 'rw' (defaults to 'r')
Returns ParamSpec<unknown>
A GObject.ParamSpec
Inherited from default.pspec
- Defined in src/service.ts:246

`Static`register

register(
    service: new (...args: any[]) => Object,
    signals?: { [signal: string]: PspecType[] },
    properties?: { [prop: string]: [type?: PspecType, handle?: PspecFlag] },
): void
Registers a GObject subclass with signals and properties.
Parameters
- service: new (...args: any[]) => Object
  The class constructor to register
- Optionalsignals: { [signal: string]: PspecType[] }
  Map of signal names to their parameter types
- Optionalproperties: { [prop: string]: [type?: PspecType, handle?: PspecFlag] }
  Map of property names to [type, accessFlag] tuples
Returns void
Inherited from default.register
- Defined in src/service.ts:257

Class Wifi

Fires

Hierarchy (View Summary)

Implements

Index

Accessors

Constructors

Methods

Accessors

access_points

Returns AccessPointInfo[]

enabled

Returns boolean

Parameters

Returns void

frequency

Returns number

icon_name

Returns string

internet

Returns "connecting" | "connected" | "disconnected"

isDisposed

Returns boolean

ssid

Returns string

state

Returns | "failed" | "disconnected" | "unmanaged" | "unavailable" | "prepare" | "config" | "need_auth" | "ip_config" | "ip_check" | "secondaries" | "activated" | "deactivating" | "unknown"

strength

Returns number

Constructors

constructor

Parameters

Returns Wifi

Methods

bind

Type Parameters

Parameters

Returns Binding<Wifi, Prop, Wifi[Prop]>

Example

changed

Parameters

Returns void

connect

Parameters

Returns number

diffBind

Type Parameters

Parameters

Returns Binding<Wifi, Prop, Widget[]>

Example

ProtecteddisconnectAll

Returns void

dispose

Returns void

emit

Parameters

Returns void

ProtectedretryWithBackoff

Type Parameters

Parameters

Returns Promise<T>

Readonlyscan

Returns void

ProtectedtrackConnection

Parameters

Returns void

Parameters

Returns void

updateProperty

Parameters

Returns void

Staticimport

Type Parameters

Parameters

Returns Promise<Services[S]>

Example

Staticpspec

Parameters

Returns ParamSpec<unknown>

Staticregister

Returns
| "failed"
| "disconnected"
| "unmanaged"
| "unavailable"
| "prepare"
| "config"
| "need_auth"
| "ip_config"
| "ip_check"
| "secondaries"
| "activated"
| "deactivating"
| "unknown"

`Protected`disconnectAll

`Protected`retryWithBackoff

`Readonly`scan

`Protected`trackConnection

`Static`import

`Static`pspec

`Static`register