概述 deferred.pipe( [doneFilter ] [, failFilter ] )
返回值:Promise
描述: 用用于过滤 and/or 链式延迟对象的工具方法。
Deprecation Notice:(推荐使用的注意事项:)从jQuery 1.8开始, deferred.pipe() 方法过时. 应该使用deferred.then()
代替它。
deferred.pipe()
方法返回一个新的promise(允诺),用于过滤状态或通过函数返回的延迟对象的值。doneFilter
和failFilter
函数过滤原先deferred(延迟)的解决/拒绝的状态和值。从 jQuery 1.7开始,该方法还接受一个progressFilter
函数,用来过滤任何访问deferred(延迟)的notify
或notifyWith
方法。这些过滤器可以随着 pipe promise 的 done()
或fail()
回调函数的调用,返回一个新值,或返回其它可见对象(Deferred, Promise, 等等),这些可见对象传递了自身的解决(resolve) / 拒绝(reject)状态和传递给 pipe promise 回调函数的值。如果将 null
作为过滤函数,或者不指定过滤函数,那么 pipe promise 被受理(resolve)或被拒绝(reject)时,会使用相同的值作为原始值。
示例
过滤解决值:
- var defer = $.Deferred(),
- filtered = defer.pipe(function( value ) {
- return value * 2;
- });
-
- defer.resolve( 5 );
- filtered.done(function( value ) {
- alert( "Value is ( 2*5 = ) 10: " + value );
- });
过滤拒绝值:
- var defer = $.Deferred(),
- filtered = defer.pipe( null, function( value ) {
- return value * 3;
- });
-
- defer.reject( 6 );
- filtered.fail(function( value ) {
- alert( "Value is ( 3*6 = ) 18: " + value );
- });
链任务:
- var request = $.ajax( url, { dataType: "json" } ),
- chained = request.pipe(function( data ) {
- return $.ajax( url2, { data: { user: data.userId } } );
- });
- chained.done(function( data ) {
- // data retrieved from url2 as provided by the first request
- });