@antiraid-ext/utils/jobserverpoll
API reference for @antiraid-ext/utils/jobserverpoll
@antiraid-ext/utils/jobserverpoll
Types
PollOptions
Raw Type
type PollOptions = {
jobId: string,
timeout_nostatuschange: number?,
callback: (dsP.Job) -> nil,
poll_interval: number
}| Prop | Type | Description |
|---|---|---|
callback | - | |
jobId | - | |
timeout_nostatuschange? | - | |
poll_interval | - |
Functions
pollJobserverTillComplete
Function Signature
function pollJobserverTillComplete(ctx: Primitives.TemplateContext, opts: PollOptions) endArguments
ctx
opts
getIconOfState
Function Signature
function getIconOfState(state: string) -> string endArguments
state
Returns
ret1
_formatValue
Function Signature
function _formatValue(value: any) -> string endArguments
value
Returns
ret1
jobToEmbed
Function Signature
function jobToEmbed(ctx: Primitives.TemplateContext, job: dsP.Job, showStatuses: boolean?, showDownloadLink: boolean?) -> (apitypes.EmbedObject, {apitypes.ComponentObjects}) endArguments
ctx
job
showStatuses
This field is optional and may not be specified
showDownloadLink
This field is optional and may not be specified
Returns
ret1
ret2
Last updated on