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

Update README.md

Browse source
This commit is contained in:
eryn L. K 2019-09-12 04:00:39 -04:00 committed by GitHub
parent 65bcf3fc17
commit 9b17c3e1a3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -5,7 +5,7 @@
</div> </div>
## Motivation ## Why you should use Promises
The way Roblox models asynchronous operations by default is by yielding (stopping) the thread and then resuming it when the future value is available. This model is not ideal because: The way Roblox models asynchronous operations by default is by yielding (stopping) the thread and then resuming it when the future value is available. This model is not ideal because:
@ -14,8 +14,6 @@ The way Roblox models asynchronous operations by default is by yielding (stoppin
- When an asynchronous operation fails or an error is encountered, Lua functions usually either raise an error or return a success value followed by the actual value. Both of these methods lead to repeating the same tired patterns many times over for checking if the operation was successful. - When an asynchronous operation fails or an error is encountered, Lua functions usually either raise an error or return a success value followed by the actual value. Both of these methods lead to repeating the same tired patterns many times over for checking if the operation was successful.
- Yielding lacks easy access to introspection and the ability to cancel an operation if the value is no longer needed. - Yielding lacks easy access to introspection and the ability to cancel an operation if the value is no longer needed.
### Goals
This Promise implementation attempts to satisfy these traits: This Promise implementation attempts to satisfy these traits:
* An object that represents a unit of asynchronous work * An object that represents a unit of asynchronous work
@ -23,7 +21,7 @@ This Promise implementation attempts to satisfy these traits:
* Predictable timing * Predictable timing
## Example ## Example
This Promise implementation finished synchronously. In order to wrap an existing async API, you should use `Promise.spawn` in order to prevent your calling thread from accidentally yielding. `Promise.async` returns synchronously.
```lua ```lua
local HttpService = game:GetService("HttpService") local HttpService = game:GetService("HttpService")