https://github.com/loadingio/proxise

Proxy for Promise resolving outside Promise function.
https://github.com/loadingio/proxise

Last synced: 18 days ago
JSON representation

Proxy for Promise resolving outside Promise function.

• Host: GitHub
• URL: https://github.com/loadingio/proxise
• Owner: loadingio
• License: mit
• Created: 2019-05-28T02:47:10.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-07T03:11:46.000Z (almost 3 years ago)
• Last Synced: 2025-10-20T06:26:56.061Z (4 months ago)
• Language: LiveScript
• Size: 200 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# proxise

Use Promise Proxy ( Proxise ) for easily resolving promises outside the Promise function.

## Usage

    somefunc = proxise (params) -> if (ready) => return Promise.resolve('some value')

    somefunc params .then (v) -> /* doing something ... */

    somefunc.resolve 'some value'

Proxise use the return value inside the proxise function to decide how things work:

 * return promise - then the promise will be used when somefunc is called.

 * otherwise - proxise create a new Promise object and enqueues it until somefunc.resolve is called.

   When somefunc.resolve is called, all queued promises will be resolved immediately.

Proxise is quite helpful for resolving promise outside the promise function, for example, by user interaction:

    until-user-click = proxise ->

    until-user-click!then -> console.log \user-clicked.

    document.body.addEventListner \click, -> until-user-click.resolve!

## proxise.once

proxise is also useful for waiting until sutff gets intiailized. In this scenario, we need:

 - wrapped function is run for at most once.

 - every invocation of the wrapped function will be resolved after successful run of the wrapped function.

You can simply use `proxise.once` to achieve this effect.

For example,

    init = proxise.once -> alert("this alert shall only popup once.")

is equivalent to

    _init = -> alert("this alert shall only popup once.")

    init = proxise ->

      if init.inited => return Promise.resolve!

      if init.initing => return

      Promise.resolve!

        .then -> _init!

        .finally -> init.initing = false

        .then -> init.inited = true

        .then -> init.resolve!

        .catch -> init.reject it

Additionally, you can ask the inited function to return a specific value by the second option:

    init = proxise.once (->), (-> "return me") 

## License

MIT