Skip to content

Commit fdee7a5

Browse files
authored
Update docs to clarify Fulfilled can also apply to undefined.
1 parent 99ccdfc commit fdee7a5

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -469,8 +469,8 @@ is set to `"application/json"`.
469469
- `status` One of: `initial`, `pending`, `fulfilled`, `rejected`.
470470
- `isInitial` true when no promise has ever started, or one started but was cancelled.
471471
- `isPending` true when a promise is currently awaiting settlement. Alias: `isLoading`
472-
- `isFulfilled` true when the last promise was fulfilled with a value. Alias: `isResolved`
473-
- `isRejected` true when the last promise was rejected with a reason.
472+
- `isFulfilled` true when the last promise was fulfilled. Alias: `isResolved`
473+
- `isRejected` true when the last promise was rejected.
474474
- `isSettled` true when the last promise was fulfilled or rejected (not initial or pending).
475475
- `counter` The number of times a promise was started.
476476
- `cancel` Cancel any pending promise.
@@ -532,23 +532,23 @@ These are available for import as `statusTypes`.
532532

533533
> `boolean`
534534
535-
`true` while a promise is pending (aka loading), `false` otherwise.
535+
`true` while a promise is pending (loading), `false` otherwise.
536536

537537
Alias: `isLoading`
538538

539539
#### `isFulfilled`
540540

541541
> `boolean`
542542
543-
`true` when the last promise was fulfilled (aka resolved) with a value.
543+
`true` when the last promise was fulfilled (resolved to a value).
544544

545545
Alias: `isResolved`
546546

547547
#### `isRejected`
548548

549549
> `boolean`
550550
551-
`true` when the last promise was rejected with an error.
551+
`true` when the last promise was rejected.
552552

553553
#### `isSettled`
554554

@@ -644,7 +644,7 @@ return (
644644

645645
### `<Pending>` / `<Async.Pending>`
646646

647-
This component renders only while the promise is pending (aka loading) (unsettled).
647+
This component renders only while the promise is pending (loading / unsettled).
648648

649649
Alias: `<Async.Loading>`
650650

@@ -677,7 +677,7 @@ return (
677677

678678
### `<Fulfilled>` / `<Async.Fulfilled>`
679679

680-
This component renders only when the promise is fulfilled with data (`data !== undefined`).
680+
This component renders only when the promise is fulfilled (resolved to a value, could be `undefined`).
681681

682682
Alias: `<Async.Resolved>`
683683

0 commit comments

Comments
 (0)