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 documentation

Browse source
This commit is contained in:
Eryn Lynn 2019-09-10 16:00:43 -04:00
parent 5d6c784e6d
commit 62c06a2698
2 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
.vuepress/config.js
View file

@ -36,7 +36,8 @@ module.exports = {
placeholder: 'Press S to search...' placeholder: 'Press S to search...'
}, },
nav: [ nav: [
{ text: 'API Reference', link: '/lib/' } { text: 'API Reference', link: '/lib/' },
{ text: 'GitHub', link: 'https://github.com/evaera/roblox-lua-promise' }
], ],
sidebarDepth: 3, sidebarDepth: 3,

3
lib/README.md
View file

@ -21,6 +21,7 @@ docs:
- name: Status - name: Status
tags: [ 'read only', 'static', 'enums' ] tags: [ 'read only', 'static', 'enums' ]
type: PromiseStatus type: PromiseStatus
desc: A table containing all members of the `PromiseStatus` enum, e.g., `Promise.Status.Resolved`.
functions: functions:
@ -94,7 +95,7 @@ docs:
- type: boolean - type: boolean
desc: "`true` if the given `object` is a Promise." desc: "`true` if the given `object` is a Promise."
- name: spawn - name: spawn
desc: Spawns a thread with predictable timing. The callback will be called on the next `RunService.Stepped` event. desc: Spawns a thread with predictable timing. The callback will be called on the next `RunService.Heartbeat` event.
static: true static: true
params: params:
- name: callback - name: callback