Add documentation for promise APIs
Signed-off-by: Tyler Rockwood <rockwood@redpanda.com>
This commit is contained in:
parent
47e07b25aa
commit
d168361207
2 changed files with 5 additions and 1 deletions
|
@ -45114,7 +45114,7 @@ JSPromiseStateEnum JS_PromiseState(JSContext *ctx, JSValue promise)
|
||||||
{
|
{
|
||||||
JSPromiseData *s = JS_GetOpaque(promise, JS_CLASS_PROMISE);
|
JSPromiseData *s = JS_GetOpaque(promise, JS_CLASS_PROMISE);
|
||||||
if (!s)
|
if (!s)
|
||||||
return -1;
|
return JS_INVALID_PROMISE_STATE;
|
||||||
return s->promise_state;
|
return s->promise_state;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -977,13 +977,17 @@ JS_EXTERN int JS_SetModuleExportList(JSContext *ctx, JSModuleDef *m,
|
||||||
|
|
||||||
/* Promise */
|
/* Promise */
|
||||||
|
|
||||||
|
#define JS_INVALID_PROMISE_STATE -1
|
||||||
|
|
||||||
typedef enum JSPromiseStateEnum {
|
typedef enum JSPromiseStateEnum {
|
||||||
JS_PROMISE_PENDING,
|
JS_PROMISE_PENDING,
|
||||||
JS_PROMISE_FULFILLED,
|
JS_PROMISE_FULFILLED,
|
||||||
JS_PROMISE_REJECTED,
|
JS_PROMISE_REJECTED,
|
||||||
} JSPromiseStateEnum;
|
} JSPromiseStateEnum;
|
||||||
|
|
||||||
|
/* Returns JSPromiseReactionEnum for the promise or JS_INVALID_PROMISE_STATE if the value is not a promise. */
|
||||||
JS_EXTERN JSPromiseStateEnum JS_PromiseState(JSContext *ctx, JSValue promise);
|
JS_EXTERN JSPromiseStateEnum JS_PromiseState(JSContext *ctx, JSValue promise);
|
||||||
|
/* Return the result of the promise if the promise's state is in the FULFILLED or REJECTED state. Otherwise returns JS_UNDEFINED. */
|
||||||
JS_EXTERN JSValue JS_PromiseResult(JSContext *ctx, JSValue promise);
|
JS_EXTERN JSValue JS_PromiseResult(JSContext *ctx, JSValue promise);
|
||||||
|
|
||||||
/* Version */
|
/* Version */
|
||||||
|
|
Loading…
Reference in a new issue