This package contains utility functions that makes use @vueuse/core and its functions.
The state of the polling.
Enumeration Member | Value |
---|---|
FAILURE |
3 |
NOT_STARTED |
0 |
POLLING |
1 |
SUCCESS |
2 |
TIMEOUT |
4 |
ElementOrComponentWithEl:
HTMLElement
| {$el
:HTMLElement
; }
Either an HTMLElement
or a Vue component with the property $el
which is an HTMLElement
.
dom.ts:8
UsePollingRetVal: {
startPolling
: () =>UsePollingRetVal
;state
:ComputedRef
<PollingState
>; }
Return value of the usePolling function.
Member | Type | Description |
---|---|---|
startPolling |
() => UsePollingRetVal
|
Start polling. |
state |
ComputedRef <PollingState > |
The current state of the polling. |
polling.ts:21
isPollingFailure(
state
):boolean
See if the given state is considered a failure, either it was considered a failure by the executing function or it had timed out.
Parameter | Type | Description |
---|---|---|
state |
PollingState |
The state to validate. |
boolean
Returns true if it is considered to be a failure, false otherwise.
polling.ts:40
useHeightCalc(
baseHeight
,elements
):ComputedRefWithControl
<string
>
In cases where we have an element where any of the height CSS styles is using the "calc" function, we may want to subtract from a base height the current height of some elements, this function allows for that.
Parameter | Type | Description |
---|---|---|
baseHeight |
string |
The base height to essentially subtract from. Ex: 90vh, 800px, 100% |
elements |
Ref <ElementOrComponentWithEl >[] |
The list of elements or components with a singular root element whose height we will subtract from. |
ComputedRefWithControl
<string
>
dom.ts:17
usePolling(
fn
,intervalMs
,timeoutMs
):UsePollingRetVal
Keep executing the provided function until it returns a success, failure, or it has timed out. Note that the next polling will not start until the current task finishes.
Parameter | Type | Description |
---|---|---|
fn |
() => Awaitable <PollingState > |
The function to execute. The function should return PollingState.POLLING to have the polling to continue. Returning either PollingState.SUCCESS or PollingState.FAILURE will stop polling. |
intervalMs |
number |
The time in milliseconds between each poll. |
timeoutMs |
number |
The maximum time in milliseconds before it is considered a polling timeout. |
Return an object with the current state of the polling and function to start the polling.
polling.ts:54