@ti-platform/aide-vueuse
TypeScript icon, indicating that this package has built-in type declarations

1.0.7 • Public • Published

@ti-platform/aide-vueuse

This package contains utility functions that makes use @vueuse/core and its functions.

Contents

API Docs

Enumerations

PollingState

The state of the polling.

Enumeration Members

Enumeration Member Value
FAILURE 3
NOT_STARTED 0
POLLING 1
SUCCESS 2
TIMEOUT 4

Type Aliases

ElementOrComponentWithEl

ElementOrComponentWithEl: HTMLElement | {$el: HTMLElement; }

Either an HTMLElement or a Vue component with the property $el which is an HTMLElement.

Source

dom.ts:8


UsePollingRetVal

UsePollingRetVal: {startPolling: () => UsePollingRetVal;state: ComputedRef<PollingState>; }

Return value of the usePolling function.

Type declaration

Member Type Description
startPolling () => UsePollingRetVal Start polling.
state ComputedRef<PollingState> The current state of the polling.

Source

polling.ts:21

Functions

isPollingFailure()

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.

Parameters

Parameter Type Description
state PollingState The state to validate.

Returns

boolean

Returns true if it is considered to be a failure, false otherwise.

Source

polling.ts:40


useHeightCalc()

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.

Parameters

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.

Returns

ComputedRefWithControl<string>

Source

dom.ts:17


usePolling()

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.

Parameters

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.

Returns

UsePollingRetVal

Return an object with the current state of the polling and function to start the polling.

Source

polling.ts:54

Readme

Keywords

none

Package Sidebar

Install

npm i @ti-platform/aide-vueuse

Weekly Downloads

9

Version

1.0.7

License

none

Unpacked Size

14.4 kB

Total Files

12

Last publish

Collaborators

  • ducyeutruc