jQuery/deferred/promise

deferred.promise( [target ] )‎

القيمة المعادة

يُعيد كائنًا من النوع Promise.

الوصف

يُعيد هذا التابع كائن Promise للكائن المؤجل Deferred.

deferred.promise( [target ] )‎

أُضيف مع الإصدار: 1.5.

target

الكائن الذي يجب إرفاق تابع promise به وهو من النوع Object.

يسمح التابع deferred.promise()‎‎ لدالة غير متزامنة بمنع الشيفرات البرمجية الأخرى من التدخل في تقدم أو حالة الطلب الداخلي الخاص به. ويعرض التابع promise فقط التوابع المؤجلة اللازمة لإرفاق معالجات إضافية أو تحديد الحالة (then و done و fail و always و pipe و progress و state و promise)، ولكن ليس التوابع التي تغير الحالة (resolve و reject و notify و resolveWith و rejectWith و notifyWith).

إذا توفَّر الكائن target، فسوف يرفق التابعُ deferred.promise()‎‎ التوابع به ثم يعيد هذا الكائن بدلاً من إنشاء كائن جديد. قد يكون ذلك مفيدًا لإرفاق سلوك الكائن Promise بكائن موجود بالفعل.

إذا كنت تنشئ كائن مؤجل Deferred، فاحتفظ بمرجع إليه بحيث يمكن قبوله أو رفضه في مرحلة ما. حاول إعادة الكائن Promise عبر التابع deferred.promise()‎‎ فقط، بحيث يمكن للشيفرات الأخرى تسجيل دوال رد النداء (callbacks) أو تفقد الحالة الحالية.

لمزيد من المعلومات، راجع توثيق الكائن Deferred.

أمثلة

إنشاء كائن مؤجل Deferred وضبط دالتين تستندان إلى مؤقِّت لقبول أو رفض الكائن المؤجل بعد فاصل عشوائي. أيهما يُطلق أولًا "يربح" ويستدعي أحد دوال رد النداء. المهلة الثانية ليس لها أي تأثير نظرًا لأن الكائن المؤجل Deferred قد اكتمل بالفعل (في حالة قبول أو رفض) أثناء إجراء المهلة الأولى. ويضبط أيضًا دالة إشعار تَقدُّم مستندة إلى مُؤقِّت، ويستدعي معالج تَقدُّم يضيف "working...‎" إلى نص المستند.

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 );
  }
);

استخدام الوسيط target لترقية كائن موجود إلى كائن Promise:

// 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"

مصادر

• صفحة التابع ‎deferred.promise()‎‎‎‎‎‎‎‎‎‎ في توثيق jQuery الرسمي.