declare module '@ember/object/promise-proxy-mixin' { import Mixin from '@ember/object/mixin'; /** A low level mixin making ObjectProxy promise-aware. ```javascript import { resolve } from 'rsvp'; import $ from 'jquery'; import ObjectProxy from '@ember/object/proxy'; import PromiseProxyMixin from '@ember/object/promise-proxy-mixin'; let ObjectPromiseProxy = ObjectProxy.extend(PromiseProxyMixin); let proxy = ObjectPromiseProxy.create({ promise: resolve($.getJSON('/some/remote/data.json')) }); proxy.then(function(json){ // the json }, function(reason) { // the reason why you have no json }); ``` the proxy has bindable attributes which track the promises life cycle ```javascript proxy.get('isPending') //=> true proxy.get('isSettled') //=> false proxy.get('isRejected') //=> false proxy.get('isFulfilled') //=> false ``` When the $.getJSON completes, and the promise is fulfilled with json, the life cycle attributes will update accordingly. Note that $.getJSON doesn't return an ECMA specified promise, it is useful to wrap this with an `RSVP.resolve` so that it behaves as a spec compliant promise. ```javascript proxy.get('isPending') //=> false proxy.get('isSettled') //=> true proxy.get('isRejected') //=> false proxy.get('isFulfilled') //=> true ``` As the proxy is an ObjectProxy, and the json now its content, all the json properties will be available directly from the proxy. ```javascript // Assuming the following json: { firstName: 'Stefan', lastName: 'Penner' } // both properties will accessible on the proxy proxy.get('firstName') //=> 'Stefan' proxy.get('lastName') //=> 'Penner' ``` @class PromiseProxyMixin @public */ interface PromiseProxyMixin { /** If the proxied promise is rejected this will contain the reason provided. @property reason @default null @public */ reason: unknown; /** Once the proxied promise has settled this will become `false`. @property isPending @default true @public */ readonly isPending: boolean; /** Once the proxied promise has settled this will become `true`. @property isSettled @default false @public */ readonly isSettled: boolean; /** Will become `true` if the proxied promise is rejected. @property isRejected @default false @public */ isRejected: boolean; /** Will become `true` if the proxied promise is fulfilled. @property isFulfilled @default false @public */ isFulfilled: boolean; /** The promise whose fulfillment value is being proxied by this object. This property must be specified upon creation, and should not be changed once created. Example: ```javascript import ObjectProxy from '@ember/object/proxy'; import PromiseProxyMixin from '@ember/object/promise-proxy-mixin'; ObjectProxy.extend(PromiseProxyMixin).create({ promise: }); ``` @property promise @public */ promise: Promise; /** An alias to the proxied promise's `then`. See RSVP.Promise.then. @method then @param {Function} callback @return {RSVP.Promise} @public */ then: this['promise']['then']; /** An alias to the proxied promise's `catch`. See RSVP.Promise.catch. @method catch @param {Function} callback @return {RSVP.Promise} @since 1.3.0 @public */ catch: this['promise']['catch']; /** An alias to the proxied promise's `finally`. See RSVP.Promise.finally. @method finally @param {Function} callback @return {RSVP.Promise} @since 1.3.0 @public */ finally: this['promise']['finally']; } const PromiseProxyMixin: Mixin; export default PromiseProxyMixin; }