Spec-Zone.ru › jQuery

.promise()

.promise( [type ] [, target ] )Возвращает: Promise

Описание: Возвращает объект Promise, чтобы отслеживать завершение всех действий определенного типа, привязанных к коллекции, вне зависимости от очереди.

  • версия добавлена: 1.6.promise( [type ] [, target ] )

    • type (по умолчанию: fx)
      Тип: Строка
      Тип очереди, который нужно отслеживать.
    • target
      Тип: Объект
      Объект, к которому необходимо прикрепить методы обещания.

Метод .promise() возвращает динамически созданный объект Promise, который разрешается, когда все действия определенного типа, привязанные к коллекции, независимо от очереди, завершатся.

По умолчанию, type равен "fx", что означает, что возвращаемый Promise разрешается, когда все анимации выбранных элементов завершатся.

Контекст разрешения и единственный аргумент — это коллекция, к которой был вызван .promise().

Если указан target, .promise() прикрепит методы к нему и вернет этот объект, вместо создания нового. Это может быть полезно для привязки поведения Promise к уже существующему объекту.

Примечание: Возвращаемый Promise связан с объектом Deferred, хранящимся в .data() для элемента. Поскольку метод .remove() удаляет данные элемента, а также сам элемент, он предотвратит разрешение любых неразрешенных Promise элемента. Если необходимо удалить элемент из DOM до разрешения его Promise, используйте .detach() и выполните .removeData() после разрешения.

Примеры:

Использование .promise() на коллекции без активной анимации возвращает разрешенный Promise:

var div = $( "<div>" );
 
div.promise().done(function( arg1 ) {
  // Will fire right away and alert "true"
  alert( this === div && arg1 === div );
});

Разрешить возвращаемый Promise, когда завершатся все анимации (включая те, что были инициированы в обработчике анимации или добавлены позже):

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>promise demo</title>
  <style>
  div {
    height: 50px;
    width: 50px;
    float: left;
    margin-right: 10px;
    display: none;
    background-color: #090;
  }
  </style>
  <script src="https://code.jquery.com/jquery-3.7.0.js"></script>
</head>
<body>
 
<button>Go</button>
<p>Ready...</p>
<div></div>
<div></div>
<div></div>
<div></div>
 
<script>
$( "button" ).on( "click", function() {
  $( "p" ).append( "Started..." );
 
  $( "div" ).each(function( i ) {
    $( this ).fadeIn().fadeOut( 1000 * ( i + 1 ) );
  });
 
  $( "div" ).promise().done(function() {
    $( "p" ).append( " Finished! " );
  });
});
</script>
 
</body>
</html>

Демо:

Разрешить возвращаемый Promise с помощью оператора $.when() (метод .promise() позволяет сделать это с jQuery коллекциями):

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>promise demo</title>
  <style>
  div {
    height: 50px;
    width: 50px;
    float: left;
    margin-right: 10px;
    display: none;
    background-color: #090;
  }
  </style>
  <script src="https://code.jquery.com/jquery-3.7.0.js"></script>
</head>
<body>
 
<button>Go</button>
<p>Ready...</p>
<div></div>
<div></div>
<div></div>
<div></div>
 
<script>
var effect = function() {
  return $( "div" ).fadeIn( 800 ).delay( 1200 ).fadeOut();
};
 
$( "button" ).on( "click", function() {
  $( "p" ).append( " Started... " );
 
  $.when( effect() ).done(function() {
    $( "p" ).append( " Finished! " );
  });
});
</script>
 
</body>
</html>

Демо:

© The jQuery Foundation and other contributors
Licensed under the MIT License.
https://api.jquery.com/promise

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API