testing-library / user-event

🐕 Simulate user events
https://testing-library.com/user-event
MIT License
2.2k stars 249 forks source link

In options, delay value is incorrectly documented as seconds (should be milliseconds) #1174

Open bsheps opened 1 year ago

bsheps commented 1 year ago

Reproduction example

See incorrect documentation here: https://github.com/testing-library/user-event/blob/main/src/options.ts#L40C76-L40C84

Prerequisites

Delay is incorrectly documented as seconds

See https://github.com/testing-library/user-event/blob/main/src/options.ts#L40C76-L40C84

Expected behavior

Delay should be documented as milliseconds.

Actual behavior

Delay is incorrectly documented as seconds.

User-event version

14.5.1

Environment

n/a

Additional context

Added test case to verify delay behavior.

bsheps commented 1 year ago

Opened PR #1175