Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / JavaScript

Animation.finished — promise dokončení animace

Animation.finished umožňuje pomocí await čekat na dokončení animace a zohlednit přitom její případné zrušení.

Verze: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Syntaxe

const completedAnimation = await animation.finished;

Animation.finished je vlastnost pouze pro čtení, která vrací Promise<Animation>. Když animace dosáhne stavu finished, třeba voláním finish(), může se promise splnit objektem animace. Není to logická hodnota ani metoda.

Když animace opustí stav finished, aktuální promise se nahradí jen tehdy, pokud už byla splněna. Pokud animace tento stav opustí dřív, než oznámení o dokončení zařazené do fronty promise splní, může tatáž promise zůstat nevyřízená. Pro další přehrávání vlastnost přečti znovu. Pokud animace není ve stavu idle, cancel() zamítne její aktuální promise finished výjimkou DOMException s názvem AbortError, pokud tato promise ještě čeká na vyřízení. Toto zamítnutí můžeš zachytit pomocí try/catch. Pokud je animace už ve stavu idle, zůstane čekající promise finished i po volání cancel() nevyřízená. await tak může dál čekat, aniž se provede blok catch. ready označuje připravenost přehrávání nebo pozastavení, nikoli dokončení animace.

Patří do Web Animations, nikoli do ECMAScriptu. Je nutná podpora prohlížeče; přítomnost Node 24 v repozitáři ji nepotvrzuje.

Příklady

(async () => {
  const element = document.createElement('div');
  element.textContent = 'Animation.finished';
  document.body.append(element);

  const animation = element.animate(
    [{ opacity: 0 }, { opacity: 1 }],
    { duration: 1000, fill: 'forwards' }
  );

  try {
    const completion = animation.finished;
    animation.finish();
    const result = await completion;
    console.log(result === animation);
    console.log(animation.playState);
  } catch (error) {
    console.log(error.name);
  } finally {
    animation.cancel();
    element.remove();
  }
})();

Výsledek

true
finished

Zobrazený kód a uvedený výsledek byly ověřeny v izolovaném prostředí metodou zaznamenanou v dokladu o ověření této přesné verze.

Zdroje