Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct documentation for wait mode #337

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Acconut
Copy link

@Acconut Acconut commented Dec 17, 2024

The documentation says to use options.wait.type to control the wait method, but the code and type definitions use options.wait.mode:

const { wait = { mode: "block" }, signal, ...data } = options;

wait?:
| { mode: "block"; interval?: number; timeout?: number }
| { mode: "poll"; interval?: number };

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant