@zeix/ui-element/docs-src/pages/api/functions/enqueue.md

UIElement - a HTML-first library for reactive Web Components

[**@zeix/ui-element**](../README.md)

***

[@zeix/ui-element](../globals.md) / enqueue

# Function: enqueue()

> **enqueue**\<`T`\>(`fn`, `dedupe?`): `Promise`\<`boolean` \| `void` \| `T`\>

Defined in: node\_modules/@zeix/cause-effect/src/scheduler.ts:147

Enqueue a function to be executed on the next animation frame

If the same Symbol is provided for multiple calls before the next animation frame,
only the latest call will be executed (deduplication).

## Type Parameters

### T

`T`

## Parameters

### fn

`Updater`

function to be executed on the next animation frame; can return updated value <T>, success <boolean> or void

### dedupe?

`symbol`

Symbol for deduplication; if not provided, a unique Symbol is created ensuring the update is always executed

## Returns

`Promise`\<`boolean` \| `void` \| `T`\>