ComputePressureObserverWrapper

Class ComputePressureObserverWrapper

A wrapper for the experimental compute pressure api which allows a callback to be called whenever certain thresholds are met.

Hierarchy

ComputePressureObserverWrapper

Index

Constructors

constructor

Accessors

IsAvailable

Methods

Constructors

constructor

new ComputePressureObserverWrapper(callback: (update: IComputePressureData) => void, thresholds: IComputePressureThresholds): ComputePressureObserverWrapper

- Defined in .temp/docdirectory/doc.d.ts:65973
A compute pressure observer will call this callback, whenever these thresholds are met.

Parameters
- callback: (update: IComputePressureData) => void
  
  The callback that is called whenever thresholds are met.
  - - (update: IComputePressureData): void
    - Parameters
      - update: IComputePressureData
      Returns void
- thresholds: IComputePressureThresholds
  
  An object containing the thresholds used to decide what value to to return for each update property (average of start and end of a threshold boundary).
Returns ComputePressureObserverWrapper

Accessors

Static IsAvailable

get IsAvailable(): boolean

- Defined in .temp/docdirectory/doc.d.ts:65983
Returns true if ComputePressureObserver is available for use, false otherwise.

Returns boolean

Methods

observeSearch playground for observe

observe(): void

- Defined in .temp/docdirectory/doc.d.ts:65987
Method that must be called to begin observing changes, and triggering callbacks.

Returns void

unobserveSearch playground for unobserve

unobserve(): void

- Defined in .temp/docdirectory/doc.d.ts:65991
Method that must be called to stop observing changes and triggering callbacks (cleanup function).

Returns void