Sovereignty/luau-promise
1
0
Fork 0
mirror of https://github.com/AmberGraceRblx/luau-promise.git synced 2025-04-24 15:50:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add docs

Browse source
This commit is contained in:
Eryn Lynn 2018-10-24 02:54:32 -04:00
parent 99cb3d62f5
commit dbcad4ab4b
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -17,8 +17,12 @@ This Promise implementation attempts to satisfy those traits.
## API
### Static Functions
* `Promise.new((resolve, reject) -> nil) -> Promise`
* `Promise.new((resolve, reject, onCancel) -> nil) -> Promise`
* Construct a new Promise that will be resolved or rejected with the given callbacks.
* You may register an optional cancellation hook by using the `onCancel` argument.
* This should be used to abort any ongoing operations leading up to the promise being settled.
* Call the `onCancel` function with a new function as its only argument to set a hook which will in turn be called when/if the promise is cancelled.
* When a promise is cancelled, calls to `resolve` or `reject` will be ignored, regardless of if you set a cancellation hook or not.
* `Promise.resolve(value) -> Promise`
* Creates an immediately resolved Promise with the given value.
* `Promise.reject(value) -> Promise`
@ -37,6 +41,13 @@ This Promise implementation attempts to satisfy those traits.
* Equivalent to the Promise/A+ `then` method.
* `Promise:catch(failureHandler) -> Promise`
* Shorthand for `Promise:andThen(nil, failureHandler)`.
* `Promise:finally(finallyHandler) -> Promise`
* Set a handler that will be called regardless of the promise's fate. The handler is called when the promise is resolved, rejected, *or* cancelled.
* Returns a new promise chained from this promise.
* `Promise:cancel() -> nil`
* Cancels this promise, preventing the promise from resolving or rejecting. Does not do anything if the promise is already settled.
* Cancellations will propagate upwards through chained promises.
* Promises will only be cancelled if all of their consumers are also cancelled. This is to say that if you call `andThen` twice on the same promise, and you cancel only one of the promises resulting from the `andThen` call, it will not cancel the parent promise until the other child promise is also cancelled.
* `Promise:await() -> ok, value`
* Yields the current thread until the given Promise completes. Returns `ok` as a bool, followed by the value that the promise returned.