deferred.promise()

分类: Deferred 对象

deferred.promise( [target ] )返回: Promise

描述: 返回一个 Deferred 的 Promise 对象。

deferred.promise() 方法允许一个异步函数阻止其他代码干扰其内部请求的进度或状态。Promise 只暴露了 Deferred 中用于附加额外处理程序或确定状态的方法 (then, done, fail, always, pipe, progress, state 和 promise)，而不暴露改变状态的方法 (resolve, reject, notify, resolveWith, rejectWith, 和 notifyWith)。

如果提供了 target，deferred.promise() 将把方法附加到它上面，然后返回这个对象，而不是创建一个新的对象。这对于将 Promise 行为附加到已存在的对象上很有用。

如果你正在创建一个 Deferred，请保留对该 Deferred 的引用，以便在某个时刻可以解决或拒绝它。通过 deferred.promise() 只返回 Promise 对象，以便其他代码可以注册回调或检查当前状态。

有关更多信息，请参阅 Deferred 对象 的文档。

示例

示例 1

创建一个 Deferred，并设置两个基于计时器的函数，用于在随机间隔后解决或拒绝 Deferred。先触发的函数“获胜”，并将调用其中一个回调。第二个超时没有效果，因为 Deferred 已经通过第一个超时操作完成（处于已解决或已拒绝状态）。同时设置一个基于计时器的进度通知函数，并调用一个进度处理程序，将“working...”添加到文档正文。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
function asyncEvent() {
  var dfd = jQuery.Deferred();
 
  // Resolve after a random interval
  setTimeout(function() {
    dfd.resolve( "hurray" );
  }, Math.floor( 400 + Math.random() * 2000 ) );
 
  // Reject after a random interval
  setTimeout(function() {
    dfd.reject( "sorry" );
  }, Math.floor( 400 + Math.random() * 2000 ) );
 
  // Show a "working..." message every half-second
  setTimeout(function working() {
    if ( dfd.state() === "pending" ) {
      dfd.notify( "working... " );
      setTimeout( working, 500 );
    }
  }, 1 );
 
  // Return the Promise so caller can't change the Deferred
  return dfd.promise();
}
 
// Attach a done, fail, and progress handler for the asyncEvent
$.when( asyncEvent() ).then(
  function( status ) {
    alert( status + ", things are going well" );
  },
  function( status ) {
    alert( status + ", you fail this time" );
  },
  function( status ) {
    $( "body" ).append( status );
  }
);

示例 2

使用 target 参数将现有对象提升为 Promise

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 
// Existing object
var obj = {
    hello: function( name ) {
      alert( "Hello " + name );
    }
  },
  // Create a Deferred
  defer = $.Deferred();
 
// Set object as a promise
defer.promise( obj );
 
// Resolve the deferred
defer.resolve( "John" );
 
// Use the object as a Promise
obj.done(function( name ) {
  obj.hello( name ); // Will alert "Hello John"
}).hello( "Karl" ); // Will alert "Hello Karl"