Interface NetworkState

Online status.

interface NetworkState {
    onLine: boolean;
    hasAnyListeners(): boolean;
    hasListeners(type: keyof NetworkStateEventMap): boolean;
    nextOnLine(abort?: Maybe<ReadonlyAbort>): Promise<void>;
    on<K extends keyof NetworkStateEventMap>(
        type: K,
        handler: EventHandler<NetworkStateEventMap[K]>,
        options?: SignalOptions,
    ): Unsubscribe;
}

Hierarchy (View Summary)

ReadonlyEventHost<NetworkStateEventMap>
- NetworkState

Implemented by

NetworkStateImpl

Index

Properties

Methods

hasAnyListeners hasListeners nextOnLine on

Properties

`Readonly`onLine

onLine: boolean

Returns the online status of the browser.

See

https://developer.mozilla.org/en-US/docs/Web/API/Navigator/onLine

Methods

hasAnyListeners

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

Returns boolean
Inherited from ReadonlyEventHost.hasAnyListeners
- Defined in event/EventHost.ts:44

hasListeners

hasListeners(type: keyof NetworkStateEventMap): boolean
Returns true if the event host has any listeners for the given type.
Parameters
- type: keyof NetworkStateEventMap
Returns boolean
Inherited from ReadonlyEventHost.hasListeners
- Defined in event/EventHost.ts:49

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>
- Defined in network/network.ts:36

on

on<K extends keyof NetworkStateEventMap>(
    type: K,
    handler: EventHandler<NetworkStateEventMap[K]>,
    options?: SignalOptions,
): Unsubscribe
Adds an event handler for the given typed event.
Type Parameters
- K extends keyof NetworkStateEventMap
Parameters
- type: K
  The key representing the event type to listen for.
- handler: EventHandler<NetworkStateEventMap[K]>
  A callback to invoke when the event with the given type is dispatched.
- Optionaloptions: SignalOptions
  Options for changing listening behavior.
Returns Unsubscribe
Returns a method, when invoked, removes the handler.
Inherited from ReadonlyEventHost.on
- Defined in event/EventHost.ts:35