DoneJS StealJS jQuery++ FuncUnit DocumentJS
3.14.1
5.0.0 4.3.0 2.3.35
  • About
  • Guides
  • API Docs
  • Community
  • Contributing
  • Bitovi
    • Bitovi.com
    • Blog
    • Design
    • Development
    • Training
    • Open Source
    • About
    • Contact Us
  • About
  • Guides
  • API Docs
    • Observables
      • can-compute
      • can-define
      • can-define/list/list
      • can-define/map/map
      • can-define-stream
      • can-define-stream-kefir
      • can-event
      • can-event/async/async
      • can-event/batch/batch
      • can-event/lifecycle/lifecycle
      • can-kefir
      • can-list
      • can-map
      • can-map-backup
      • can-map-define
      • can-observation
      • can-observe
      • can-simple-map
      • can-simple-observable
      • can-stream
      • can-stream-kefir
    • Data Modeling
      • can-connect
      • can-connect-cloneable
      • can-connect-feathers
      • can-connect-ndjson
      • can-connect-signalr
      • can-fixture
      • can-fixture-socket
      • can-ndjson-stream
      • can-set
    • Views
      • can-component
      • can-ejs
      • can-element
      • can-react-component
      • can-stache
      • can-stache/helpers/route
      • can-stache-bindings
      • can-stache-converters
      • can-view-autorender
      • can-view-callbacks
      • can-view-href
      • can-view-import
      • can-view-live
      • can-view-model
      • can-view-nodelist
      • can-view-parser
      • can-view-scope
      • can-view-target
      • react-view-model
      • react-view-model/component
      • steal-stache
    • Routing
      • can-deparam
      • can-param
      • can-route
      • can-route-pushstate
    • JS Utilities
      • can-assign
      • can-define-lazy-value
      • can-globals
      • can-key-tree
      • can-make-map
      • can-parse-uri
      • can-string
      • can-string-to-any
      • can-util
      • can-zone
      • can-zone-storage
    • DOM Utilities
      • can-ajax
      • can-attribute-encoder
      • can-control
      • can-dom-events
      • can-event-dom-enter
      • can-event-dom-radiochange
      • can-jquery
    • Data Validation
      • can-define-validate-validatejs
      • can-validate
      • can-validate-interface
      • can-validate-legacy
      • can-validate-validatejs
    • Typed Data
      • can-cid
      • can-construct
      • can-construct-super
      • can-namespace
      • can-reflect
      • can-reflect-promise
      • can-types
    • Polyfills
      • can-symbol
      • can-vdom
    • Core
    • Infrastructure
      • can-global
      • can-test-helpers
    • Ecosystem
    • Legacy
  • Community
  • Contributing
  • GitHub
  • Twitter
  • Chat
  • Forum
  • News
Bitovi

can-reflect-promise

  • npm package badge
  • Star
  • Edit on GitHub

Expose an observable, Map-like API on Promise types.

canReflectPromise(promise)

If promise is an instance of a Promise type (either provided natively by the platform or by a polyfill library), the prototype of the Promise type is decorated with can-symbol symbols for @@can.onKeyValue, @@can.offKeyValue, @@can.getKeyValue, @@can.onValue, and @@can.offValue, which allow it to be used like an observable Map-like in reflection.

Then promise and all future instances of promise.constructor will be initialized on first access to have the following keys available through @@can.getKeyValue:

  • "state" -- one of "pending", "resolved", or "rejected"
  • "isPending" -- true if the promise neither resolved nor rejected, false otherwise.
  • "isResolved" -- true if the promise is resolved, false otherwise.
  • "isRejected" -- true if the promise is rejected, false otherwise.
  • "value" -- the resolved value of the promise if resolved, otherwise undefined.
  • "reason" -- the rejected value of the promise if rejected, otherwise undefined.

Note that, due to native Promises' lack of inspection, it is impossible to tell whether a Promise is resolved or rejected without using .then(). If the Promise is Promises/A+ compliant, then at the time the Promise is initialized by can-reflect-promise, isPending will always be true, even if the Promise has already resolved, and will remain so during synchronous execution. On the next tick, the state will update to resolved/rejected if the Promise has already updated its state. The best strategy for ensuring a proper read of a resolved value or rejected reason is to listen for the change in state or value with @@can.onKeyValue immediately after creating a Promise.

In the cases where promise is a plain object (e.g. if it is a jQuery.Deferred), the symbols will be applied to promise itself, not to the proto.

var p = new Promise(function(resolve) {
    setTimeout(resolve.bind(null, "a"), 10);
});

canReflectPromise(p);

canReflect.getKeyValue(p, "isPending"); // -> true

setTimeout(function() {
    canReflect.getKeyValue(p, "isResolved"); // -> true
    canReflect.getKeyValue(p, "value"); // -> "a"
}, 20);

Parameters

  1. promise {Promise}:

    any Promise, Promise-like, or thenable.

CanJS is part of DoneJS. Created and maintained by the core DoneJS team and Bitovi. Currently 3.14.1.

On this page

Get help

  • Chat with us
  • File an issue
  • Ask questions
  • Read latest news