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

Browse source
This commit is contained in:
Eryn Lynn 2019-09-10 15:41:59 -04:00
parent 9a1d1c3530
commit 5d6c784e6d
2 changed files with 2 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.vuepress/.gitignore vendored Normal file
View file

@ -0,0 +1 @@
dist/

9
README.md
View file

@ -1,10 +1,3 @@
---
home: true
actionText: API docs →
actionLink: /lib/
footer: MIT Licensed
---
# Roblox Lua Promise # Roblox Lua Promise
An implementation of `Promise` similar to Promise/A+. An implementation of `Promise` similar to Promise/A+.
@ -26,7 +19,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 `spawn` or `delay` in order to prevent your calling thread from accidentally yielding. 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.
```lua ```lua
local HttpService = game:GetService("HttpService") local HttpService = game:GetService("HttpService")