mirror of
https://github.com/AmberGraceRblx/luau-promise.git
synced 2025-04-24 15:50:01 +00:00
Update documentation
This commit is contained in:
parent
5d6c784e6d
commit
62c06a2698
2 changed files with 4 additions and 2 deletions
|
@ -36,7 +36,8 @@ module.exports = {
|
|||
placeholder: 'Press S to search...'
|
||||
},
|
||||
nav: [
|
||||
{ text: 'API Reference', link: '/lib/' }
|
||||
{ text: 'API Reference', link: '/lib/' },
|
||||
{ text: 'GitHub', link: 'https://github.com/evaera/roblox-lua-promise' }
|
||||
],
|
||||
|
||||
sidebarDepth: 3,
|
||||
|
|
|
@ -21,6 +21,7 @@ docs:
|
|||
- name: Status
|
||||
tags: [ 'read only', 'static', 'enums' ]
|
||||
type: PromiseStatus
|
||||
desc: A table containing all members of the `PromiseStatus` enum, e.g., `Promise.Status.Resolved`.
|
||||
|
||||
|
||||
functions:
|
||||
|
@ -94,7 +95,7 @@ docs:
|
|||
- type: boolean
|
||||
desc: "`true` if the given `object` is a Promise."
|
||||
- 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
|
||||
params:
|
||||
- name: callback
|
||||
|
|
Loading…
Reference in a new issue