Class NetworkStateImpl

Online status.

Hierarchy (View Summary)

DomEventHost<NetworkStateEventMap>
- NetworkStateImpl

Implements

NetworkState

Index

Constructors

Properties

deps eventTarget

Accessors

Methods

dispose hasAnyListeners hasListeners nextOnLine on createDefaultDeps

Constructors

constructor

new NetworkStateImpl(deps?: NetworkStateImplDeps): NetworkStateImpl
Parameters
- deps: NetworkStateImplDeps = ...
Returns NetworkStateImpl
Overrides DomEventHost.constructor
- Defined in network/network.ts:70

Properties

`Protected` `Readonly`deps

deps: NetworkStateImplDeps = ...

`Protected` `Readonly`eventTarget

eventTarget: EventTarget

Accessors

onLine

get onLine(): boolean
Returns the online status of the browser.

Returns boolean

See
https://developer.mozilla.org/en-US/docs/Web/API/Navigator/onLine
Implementation of NetworkState.onLine
- Defined in network/network.ts:76

Methods

dispose

dispose(): void
Disposal of a DomEventHost removes all listeners.

Returns void
Inherited from DomEventHost.dispose
- Defined in event/DomEventHost.ts:93

hasAnyListeners

hasAnyListeners(): boolean
Returns true if the event host has any listeners.

Returns boolean
Implementation of NetworkState.hasAnyListeners

Inherited from DomEventHost.hasAnyListeners
- Defined in event/DomEventHost.ts:58

hasListeners

hasListeners(type: "offline" | "online"): boolean
Returns true if the event host has any listeners for the given type.
Parameters
- type: "offline" | "online"
Returns boolean
Implementation of NetworkState.hasListeners

Inherited from DomEventHost.hasListeners
- Defined in event/DomEventHost.ts:62

nextOnLine

nextOnLine(abort?: Maybe<ReadonlyAbort>): Promise<void>
Returns a promise that resolves when the network state is next online. Rejects immediately if the given abortSignal is in an aborted state. Resolves immediately if the navigator is currently online.
Parameters
- Optionalabort: Maybe<ReadonlyAbort>
  If provided, rejects the returned promise when aborted.
Returns Promise<void>
Implementation of NetworkState.nextOnLine
- Defined in network/network.ts:80

on

on<K extends "offline" | "online">(
    type: K,
    handler: EventHandler<DomEventMap<NetworkStateEventMap>[K]>,
    options?: DomEventListenerOptions,
): Unsubscribe
Adds an event handler for the given typed event.
Type Parameters
- K extends "offline" | "online"
Parameters
- type: K
  A case-sensitive string representing the event type to listen for.
- handler: EventHandler<DomEventMap<NetworkStateEventMap>[K]>
  A callback to invoke when the event with the given type is dispatched.
- Optionaloptions: DomEventListenerOptions
  An options object specifies characteristics about the event listener.
Returns Unsubscribe
Returns a method, when invoked, removes the handler.
Implementation of NetworkState.on

Inherited from DomEventHost.on
- Defined in event/DomEventHost.ts:66

`Static`createDefaultDeps

createDefaultDeps(): NetworkStateImplDeps
Returns NetworkStateImplDeps
- Defined in network/network.ts:49