Skip to content

Commit bfbb352

Browse files
authored
docs(readme): fix documentation mistakes for useAsyncIterMulti's options object argument (#67)
1 parent 8a6fc81 commit bfbb352

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -983,8 +983,11 @@ const [nextNum, nextStr, nextArr] = useAsyncIterMulti([numberIter, stringIter, a
983983
- `values`:
984984
An array of values to iterate over simultaneously, which may include any mix of async iterables or plain (non async iterable) values. Source values may be added, removed or changed at any time and new iterations will be close and started accordingly as per [Iteration lifecycle](#iteration-lifecycle).
985985

986-
- `initialValues`:
987-
An optional array of initial values. The values here will be the starting points for all the async iterables from `values` (correspondingly by matching array positions) while they are rendered by the `children` render function __for the first time__ and for each while it is __pending its first yield__. Async iterables from `values` that have no initial value corresponding to them will assume `undefined` as initial value.
986+
- `opts`:
987+
An _optional_ object with properties:
988+
989+
- `initialValues`:
990+
An _optional_ array of initial values. The values here will be the starting points for all the async iterables from `values` (correspondingly by matching array positions) while they are rendered by the `children` render function __for the first time__ and for each while it is __pending its first yield__. Async iterables from `values` that have no initial value corresponding to them will assume `undefined` as initial value.
988991

989992
### Returns
990993

0 commit comments

Comments
 (0)