Share via


WinJS.Utilities.Scheduler.schedulePromiseIdle function

Schedules a job to complete the returned Promise at WinJS.Utilities.Scheduler.Priority.Idle priority. This function is to be used as a onCompleted handler in Promise chains to set the priority of the next link in the chain.

Syntax

var p = WinJS.Utilities.Scheduler.schedulePromiseIdle(promiseValue, jobName);

Parameters

  • promiseValue [optional]
    Type: Object

    The value returned by the completed Promise.

  • jobName [optional]
    Type: String

    A string that describes the job for diagnostic purposes.

Return value

Type: WinJS.Promise**

A Promise that completes within a job of idle priority.

Requirements

Minimum WinJS version

WinJS 2.0

Namespace

WinJS.Utilities.Scheduler